diff --git a/doc/source/_static/synadm.css b/doc/source/_static/synadm.css index 59aa1ef..c6cd3c0 100644 --- a/doc/source/_static/synadm.css +++ b/doc/source/_static/synadm.css @@ -5,10 +5,16 @@ html[data-theme="light"] { html[data-theme="light"] { --pst-color-inline-code: #a23632; } -*/ table tr:hover td { background-color: var(--bs-gray-300); } +table { + display: table; + overflow-x: auto; + white-space: nowrap; +} +table,thead,tbody {width:98%} +*/ /* pydata teal (primary): #126A7E */ /* pydata violet (secondary): #7D0E70 */ diff --git a/doc/source/conf.py b/doc/source/conf.py index 9b0a639..acdc5d9 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -60,11 +60,11 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "sphinx_book_theme" -#html_theme = "pydata_sphinx_theme" -#html_theme = "furo" -#html_theme = "press" -#html_theme = "alabaster" +# html_theme = "sphinx_book_theme" +# html_theme = "pydata_sphinx_theme" +html_theme = "furo" +# html_theme = "press" +# html_theme = "alabaster" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, @@ -72,16 +72,15 @@ # html_static_path = ['_static'] html_theme_options = { - "collapse_navigation": True, - "logo": { - "text": "synadm - The Synapse Admin CLI", - }, - "pygment_light_style": "bw", + # "light_css_variables": { + # "color-brand-primary": "#343a40", + # # "color-brand-content": "#495057", + # # "color-admonition-background": "orange", + # }, } -html_title = "synadm" -#html_logo = "_static/beets_logo_nobg.png" -html_static_path = ["_static"] -html_css_files = ["synadm.css"] +# html_title = "synadm - the Synapse Admin CLI" +# html_static_path = ["_static"] +# html_css_files = ["synadm.css"] # -- Extension configuration ------------------------------------------------- diff --git a/doc/source/features.rst b/doc/source/features.rst index 2ce976a..dddbcdc 100644 --- a/doc/source/features.rst +++ b/doc/source/features.rst @@ -12,7 +12,9 @@ Account Validity .. csv-table:: :file: features/account_validity.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Background Updates ------------------ @@ -20,7 +22,9 @@ Background Updates .. csv-table:: :file: features/background_updates.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Delete Group ------------ @@ -28,7 +32,9 @@ Delete Group .. csv-table:: :file: features/delete_group.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Event Reports ------------- @@ -36,7 +42,9 @@ Event Reports .. csv-table:: :file: features/event_reports.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Experimental Features --------------------- @@ -44,7 +52,9 @@ Experimental Features .. csv-table:: :file: features/experimental_features.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Media ----- @@ -52,8 +62,9 @@ Media .. csv-table:: :file: features/media.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 - :keepspace: + :align: left Purge History ------------- @@ -61,7 +72,9 @@ Purge History .. csv-table:: :file: features/purge_history.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Register Users -------------- @@ -69,7 +82,9 @@ Register Users .. csv-table:: :file: features/register_users.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Registration Tokens ------------------- @@ -77,7 +92,9 @@ Registration Tokens .. csv-table:: :file: features/registration_tokens.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Manipulate Room Membership -------------------------- @@ -85,7 +102,9 @@ Manipulate Room Membership .. csv-table:: :file: features/manipulate_room_membership.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Rooms ----- @@ -93,7 +112,9 @@ Rooms .. csv-table:: :file: features/rooms.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Server Notices -------------- @@ -101,7 +122,9 @@ Server Notices .. csv-table:: :file: features/server_notices.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Statistics ---------- @@ -109,7 +132,9 @@ Statistics .. csv-table:: :file: features/statistics.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Users ----- @@ -117,7 +142,9 @@ Users .. csv-table:: :file: features/users.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Server Version -------------- @@ -125,7 +152,9 @@ Server Version .. csv-table:: :file: features/server_version.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Federation ---------- @@ -133,7 +162,9 @@ Federation .. csv-table:: :file: features/federation.csv :header: "Synapse Admin API","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left Miscellaneous ------------- @@ -141,7 +172,9 @@ Miscellaneous .. csv-table:: :file: features/miscellaneous.csv :header: "Description","synadm command(s)" + :width: 98% :widths: 1 1 + :align: left .. _documentation source directory: diff --git a/rtd_requirements.txt b/rtd_requirements.txt index 950012e..e8b8f48 100644 --- a/rtd_requirements.txt +++ b/rtd_requirements.txt @@ -21,7 +21,7 @@ requests==2.31.0 snowballstemmer==2.2.0 Sphinx==7.2.3 sphinx-click==5.0.1 -sphinx-book-theme==1.1.3 +furo==2024.8.6 sphinxcontrib-applehelp==1.0.7 sphinxcontrib-devhelp==1.0.5 sphinxcontrib-htmlhelp==2.0.4 diff --git a/sphinx_requirements.txt b/sphinx_requirements.txt index 92dfaa1..972a47d 100644 --- a/sphinx_requirements.txt +++ b/sphinx_requirements.txt @@ -1,5 +1,5 @@ Jinja2<3.1 Sphinx sphinx-click -sphinx-book-theme +furo myst-parser