Documentation fixes and revamp user guide

[ric-plt/lib/rmr.git] / docs / index.rst

diff --git a/docs/index.rst b/docs/index.rst
index c9289fb..febfb0f 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,6 +3,8 @@
 
 
 .. 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
@@ -10,12 +12,65 @@ RIC Message Router -- RMR
 
 
 .. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+   :maxdepth: 1
+   :caption: Documents:
 
    overview.rst
    config-deploy.rst
+   user-guide.rst
    developer-guide.rst
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Misc:
+
    rel-notes.rst
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Manual Pages:
+
+   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`