Move rmr python api docs over.

[ric-plt/xapp-frame-py.git] / docs / rmr_api.rst

diff --git a/docs/rmr_api.rst b/docs/rmr_api.rst
new file mode 100644 (file)
index 0000000..e3d5f0e
--- /dev/null
+++ b/docs/rmr_api.rst
@@ -0,0 +1,16 @@
+RMR
+====
+
+Overview
+--------
+The xapp framework repo includes a python submodule called `rmr`.
+This package (`ricxappframe.rmr`) is a CTYPES wrapper around the C rmr library.
+Most Xapp users will never use this package natively; however python apps that need access to the low level rmr API can use this package.
+Usage of this python package requires that you have the c rmr libraries installed.
+
+
+.. API
+.. ---
+
+.. .. automodule:: ricxappframe.rmr.rmr
+..   :members: