From 4a0600967215e5ace3b0c213adf485ff7c158fc0 Mon Sep 17 00:00:00 2001 From: Minijackson Date: Wed, 23 Apr 2025 15:59:47 +0200 Subject: [PATCH 1/2] docs: switch to Read the Docs theme the "Read the Docs" Sphinx theme provides a sidebar that is consistent across all pages, which makes it easier to navigate. --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 58c72db57f..6a8787abcc 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -91,7 +91,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the From fc24bbeb12f8e471c9e84a27c35be4c60a2db53b Mon Sep 17 00:00:00 2001 From: Minijackson Date: Thu, 24 Apr 2025 08:41:05 +0200 Subject: [PATCH 2/2] docs/index: use the caption toctree argument this makes it so that the caption is shown on the sidebar, and clearly separate the user and dev documentation --- docs/source/index.rst | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 49f500a3a7..5d748145d0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,10 +8,9 @@ Welcome to the CS-Studio/Phoebus Documentation! .. image:: splash.png -User Documentation: - .. toctree:: :maxdepth: 1 + :caption: User Documentation intro running @@ -24,10 +23,9 @@ User Documentation: services services_architecture -Developer Documentation: - .. toctree:: :maxdepth: 1 + :caption: Developer Documentation develop phoebus_product @@ -41,11 +39,3 @@ Developer Documentation: trouble_shooting eclipse_debugging gui_testing - -Appendix -======== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` -