restructure pyreverse documentation

pylint-dev · Nov 3, 2024 · 49be51e · 49be51e
1 parent 15a5ac0
commit 49be51e
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 6 deletions.
diff --git a/doc/additional_tools/pyreverse/configuration.rst b/doc/additional_tools/pyreverse/configuration.rst
@@ -3,8 +3,8 @@
 
 
 
-Pyreverse Configuration
-^^^^^^^^^^^^^^^^^^^^^^^
+Pyreverse Configuration Options
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 
 Filtering and Scope

diff --git a/doc/additional_tools/pyreverse/index.rst b/doc/additional_tools/pyreverse/index.rst
@@ -10,18 +10,34 @@ If Graphviz (or the ``dot`` command) is installed, all `output formats supported
 can be used as well. In this case, ``pyreverse`` first generates a temporary ``.gv`` file, which is then
 fed to Graphviz to generate the final image.
 
-Running Pyreverse
+Using Pyreverse
 '''''''''''''''''
 
 To run ``pyreverse``, use::
 
   pyreverse [options] <packages>
 
-<packages> can also be a single Python module.
-To see a full list of the available options, run::
+[options] can be specified to modify the behavior of pyreverse, and
+<packages> can either be a package or a list of modules separated by spaces.
+
+Configuration Options
+.....................
+
+To see a full list of the available [options], run::
 
    pyreverse -h
 
+For detailed descriptions of the command-line options available for Pyreverse, refer to the dedicated `Pyreverse Configuration Options <configuration.html>`_ page. This page includes sections on:
+
+* `Filtering and Scope <configuration.html#filtering-and-scope>`_ - Options for filtering classes and limiting the scope of the generated diagrams.
+* `Display Options <configuration.html#display-options>`_ - Customize how diagrams are rendered, including colors and module names.
+* `Output Control <configuration.html#output-control>`_ - Specify output formats and directory locations for generated files.
+* `Project Configuration <configuration.html#project-configuration>`_ - Configure project-specific settings such as ignored files and source roots.
+
+.. toctree::
+  :maxdepth: 1
+  :hidden:
+
 Example Output
 ''''''''''''''
 

diff --git a/doc/exts/pyreverse_configuration.py b/doc/exts/pyreverse_configuration.py
@@ -32,7 +32,7 @@ def _write_config_page(run: Run) -> None:
     sections: list[str] = [
         ".. This file is auto-generated. Make any changes to the associated\n"
         ".. docs extension in 'doc/exts/pyreverse_configuration.py'.\n\n",
-        get_rst_title("Pyreverse Configuration", "^"),
+        get_rst_title("Pyreverse Configuration Options", "^"),
     ]
 
     options: list[OptionsData] = [OptionsData(name, info) for name, info in run.options]