Move wrapped C library to subpackage

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

diff --git a/docs/rmr_api.rst b/docs/rmr_api.rst
index e3d5f0e..a33d6a1 100644 (file)
--- a/docs/rmr_api.rst
+++ b/docs/rmr_api.rst
@@ -1,16 +1,26 @@
-RMR
-====
+RMR Python Bindings
+===================
 
 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.
 
+The xapp python framework repository includes a python submodule
+called `rmr`.  This package (`ricxappframe.rmr`) is a CTYPES wrapper
+around the RMR shared 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 RMR shared-object library installed.
 
-.. API
-.. ---
 
-.. .. automodule:: ricxappframe.rmr.rmr
-..   :members:
+RMR API
+-------
+
+.. automodule:: ricxappframe.rmr.rmr
+    :members:
+
+
+RMR Helper API
+--------------
+
+.. automodule:: ricxappframe.rmr.helpers
+    :members: