Add to docs an API/Command overview as a table

doc/source/conf.py

@@ -71,7 +71,7 @@
     'collapse_navigation': True,
     'navigation_depth': 8,
     'sticky_navigation': False,
-    'prev_next_buttons_location': 'both'
+    'prev_next_buttons_location': 'bottom'
 }
 
 

doc/source/features.csv

@@ -0,0 +1,22 @@
+Synapse API,synadm command group(s)
+`Acount Validity <https://element-hq.github.io/synapse/develop/admin_api/account_validity.html>`_,
+`Delete Group <https://element-hq.github.io/synapse/develop/admin_api/delete_group.html>`_,`synadm group <https://synadm.readthedocs.io/en/latest/synadm.cli.group.html>`_
+`Event Reports <https://element-hq.github.io/synapse/develop/admin_api/event_reports.html>`_,
+`Media Admin <https://element-hq.github.io/synapse/develop/admin_api/media_admin_api.html>`_,"* `synadm media <https://synadm.readthedocs.io/en/latest/synadm.cli.media.html>`_
+* `synadm user <https://synadm.readthedocs.io/en/latest/synadm.cli.user.html>`_"
+`Purge History <https://element-hq.github.io/synapse/develop/admin_api/purge_history_api.html>`_,`synadm history <https://synadm.readthedocs.io/en/latest/synadm.cli.history.html>`_
+`Purge Room <https://element-hq.github.io/synapse/develop/admin_api/purge_room.html>`_,`synadm room <https://synadm.readthedocs.io/en/latest/synadm.cli.room.html>`_
+`Register <https://element-hq.github.io/synapse/develop/admin_api/register_api.html>`_,
+`Room Membership <https://element-hq.github.io/synapse/develop/admin_api/room_membership.html>`_,`synadm room <https://synadm.readthedocs.io/en/latest/synadm.cli.room.html>`_
+`Rooms <https://element-hq.github.io/synapse/develop/admin_api/rooms.html>`_,`synadm room <https://synadm.readthedocs.io/en/latest/synadm.cli.room.html>`_
+`Server Notices <https://element-hq.github.io/synapse/develop/admin_api/server_notices.html>`_,`synadm notice <https://synadm.readthedocs.io/en/latest/synadm.cli.notice.html>`_
+`Statistics <https://element-hq.github.io/synapse/develop/admin_api/statistics.html>`_,
+`User Admin <https://element-hq.github.io/synapse/develop/admin_api/user_admin_api.html>`_,`synadm user <https://synadm.readthedocs.io/en/latest/synadm.cli.user.html>`_
+`Version <https://element-hq.github.io/synapse/develop/admin_api/version_api.html>`_,`synadm version <https://synadm.readthedocs.io/en/latest/synadm.cli.version.html>`_
+`Registration Tokens <https://element-hq.github.io/synapse/develop/usage/administration/admin_api/registration_tokens.html>`_,`synadm regtok <https://synadm.readthedocs.io/en/latest/synadm.cli.regtok.html>`_
+`Background Update <https://element-hq.github.io/synapse/develop/usage/administration/admin_api/background_updates.html>`_,
+`Èxperimental Features <https://element-hq.github.io/synapse/develop/admin_api/experimental_features.html>`_,
+`Federation https://element-hq.github.io/synapse/develop/usage/administration/admin_api/federation.html>`_,
+,`synadm config <https://synadm.readthedocs.io/en/latest/synadm.cli.config.html>`_
+,`synadm raw <https://synadm.readthedocs.io/en/latest/synadm.cli.raw.html>`_
+,`synadm matrix <https://synadm.readthedocs.io/en/latest/synadm.cli.matrix.html>`_

doc/source/features.rst

@@ -0,0 +1,8 @@
+API Coverage
+=========================
+
+.. csv-table:: Admin API vs Command Overview
+   :file: features.csv
+   :header-rows: 1
+   :class: longtable
+   :widths: 1 1

doc/source/index.rst

@@ -10,6 +10,7 @@ Welcome to synadm's documentation!
    :maxdepth: 2
 
    index_cli_reference
+   features
    examples
    index_modules