.. 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
+.. toctree::
+ :maxdepth: 1
+ :caption: Manual Pages:
+
+ rmr.7.rst
+ rmr_alloc_msg.3.rst
+ rmr_bytes2meid.3.rst
+ rmr_bytes2payload.3.rst
+ rmr_bytes2xact.3.rst
+ rmr_call.3.rst
+ rmr_close.3.rst
+ rmr_free_msg.3.rst
+ rmr_get_const.3.rst
+ rmr_get_meid.3.rst
+ rmr_get_rcvfd.3.rst
+ rmr_get_src.3.rst
+ rmr_get_srcip.3.rst
+ rmr_get_trace.3.rst
+ rmr_get_trlen.3.rst
+ rmr_get_xact.3.rst
+ rmr_init.3.rst
+ rmr_init_trace.3.rst
+ rmr_mt_call.3.rst
+ rmr_mt_rcv.3.rst
+ rmr_payload_size.3.rst
+ rmr_rcv_msg.3.rst
+ rmr_ready.3.rst
+ rmr_realloc_payload.3.rst
+ rmr_rts_msg.3.rst
+ rmr_send_msg.3.rst
+ rmr_set_fack.3.rst
+ rmr_set_stimeout.3.rst
+ rmr_set_trace.3.rst
+ rmr_set_vlevel.3.rst
+ rmr_str2meid.3.rst
+ rmr_str2xact.3.rst
+ rmr_support.3.rst
+ rmr_torcv_msg.3.rst
+ rmr_trace_ref.3.rst
+ rmr_tralloc_msg.3.rst
+ rmr_wh_call.3.rst
+ rmr_wh_close.3.rst
+ rmr_wh_open.3.rst
+ rmr_wh_send_msg.3.rst
+ rmr_wh_state.3.rst
+
+
* :ref:`search`
Code Review / ric-plt / lib / rmr.git / blobdiff