-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 package includes a python subpackage called
+`rmr`. This subpackage (`ricxappframe.rmr`) is a CTYPES wrapper
+around the RMR shared library. Most Xapp users will never use this
+subpackage natively; however python apps that need access to the
+low-level RMR API can use it.
-.. API
-.. ---
+Usage of this python package requires that the RMR shared-object
+library is installed in a system library that is included in the
+directories found by default, usually something like /usr/local/lib.
-.. .. automodule:: ricxappframe.rmr.rmr
-.. :members:
+The RMR library man pages are available here: :doc:`RMR Man Pages <ric-plt-lib-rmr:index>`
+
+RMR API
+-------
+
+.. automodule:: ricxappframe.rmr.rmr
+ :members:
+
+
+RMR Helper API
+--------------
+
+.. automodule:: ricxappframe.rmr.helpers
+ :members: