Fix core dump in rmr_probe when -r option given
[ric-plt/lib/rmr.git] / docs / index.rst
index febfb0f..d0d3aeb 100644 (file)
@@ -2,27 +2,27 @@
 .. SPDX-License-Identifier: CC-BY-4.0
 
 
-.. who in bloody hell knows what format this should be; guessing!
-.. it does seem though that every .rst file in the directory must be listed here
-.. or tox will complain and fail.
-
-
 RIC Message Router -- RMR
-==========================
+=========================
 
+Please refer to the `main RMR manual page <https://docs.o-ran-sc.org/projects/o-ran-sc-ric-plt-lib-rmr/en/latest/rmr.7.html>`_ 
+for an overview of the library.
 
 .. toctree::
    :maxdepth: 1
    :caption: Documents:
+   :titlesonly:
 
-   overview.rst
+   installation-guide.rst
    config-deploy.rst
    user-guide.rst
    developer-guide.rst
+   rt_tables.rst
+   msg_types.rst
 
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Misc:
 
    rel-notes.rst
@@ -31,6 +31,7 @@ RIC Message Router -- RMR
    :maxdepth: 1
    :caption: Manual Pages:
 
+   rmr.7.rst
    rmr_alloc_msg.3.rst
    rmr_bytes2meid.3.rst
    rmr_bytes2payload.3.rst