X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=docs%2Frmr_api.rst;fp=docs%2Frmr_api.rst;h=e3d5f0e261afd5bc6056ed17dfd458003003ca27;hb=fbb5928134d64dbab8bc3e64b23c2f21e4c4be6f;hp=0000000000000000000000000000000000000000;hpb=25acb2e3753d3a2cb1b524170353d5296d2af8bc;p=ric-plt%2Fxapp-frame-py.git

diff --git a/docs/rmr_api.rst b/docs/rmr_api.rst
new file mode 100644
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: