From 18ee1c3d721790051a257f7d0afac17956561cfb Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 10 Nov 2024 09:27:56 +0100 Subject: [PATCH] work in progress more depth --- doc/additional_tools/pyreverse/configuration.rst | 12 ++++++------ doc/additional_tools/pyreverse/index.rst | 5 ++++- doc/exts/pyreverse_configuration.py | 4 ++-- doc/index.rst | 1 + 4 files changed, 13 insertions(+), 9 deletions(-) diff --git a/doc/additional_tools/pyreverse/configuration.rst b/doc/additional_tools/pyreverse/configuration.rst index 712265a489..010e2757f7 100644 --- a/doc/additional_tools/pyreverse/configuration.rst +++ b/doc/additional_tools/pyreverse/configuration.rst @@ -2,8 +2,8 @@ .. docs extension in 'doc/exts/pyreverse_configuration.py'. -Basic usage -########### +Usage +##### To run ``pyreverse``, use:: @@ -22,7 +22,7 @@ For detailed descriptions of the command-line options read on. This page include Filtering and Scope -################### +''''''''''''''''''' .. _filtering-and-scope: @@ -90,7 +90,7 @@ Filtering and Scope Display Options -############### +''''''''''''''' .. _display-options: @@ -140,7 +140,7 @@ Display Options Output Control -############## +'''''''''''''' .. _output-control: @@ -162,7 +162,7 @@ Output Control Project Configuration -##################### +''''''''''''''''''''' .. _project-configuration: diff --git a/doc/additional_tools/pyreverse/index.rst b/doc/additional_tools/pyreverse/index.rst index 8f6b21f6c2..5911c0451a 100644 --- a/doc/additional_tools/pyreverse/index.rst +++ b/doc/additional_tools/pyreverse/index.rst @@ -12,7 +12,10 @@ can be used as well. In this case, ``pyreverse`` first generates a temporary ``. fed to Graphviz to generate the final image. .. toctree:: - :maxdepth: 1 + :caption: Pyreverse + :maxdepth: 3 + :titlesonly: + :hidden: configuration output_examples diff --git a/doc/exts/pyreverse_configuration.py b/doc/exts/pyreverse_configuration.py index 0acaa946d4..48e8f8a9b3 100644 --- a/doc/exts/pyreverse_configuration.py +++ b/doc/exts/pyreverse_configuration.py @@ -35,7 +35,7 @@ def _write_config_page(run: Run) -> None: .. docs extension in 'doc/exts/pyreverse_configuration.py'. -{get_rst_title("Basic usage", "#")} +{get_rst_title("Usage", "#")} To run ``pyreverse``, use:: @@ -69,7 +69,7 @@ def _write_config_page(run: Run) -> None: for group_title in OPTIONS_GROUPS.values(): ref_title = group_title.lower().replace(" ", "-") sections.append( - f"""{get_rst_title(group_title, "#")} + f"""{get_rst_title(group_title, "'")} .. _{ref_title}: diff --git a/doc/index.rst b/doc/index.rst index 8bcdeac8bb..d1e862987b 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -30,6 +30,7 @@ .. toctree:: :caption: Additional tools + :maxdepth: 3 :titlesonly: :hidden: