move elsewhere

pylint-dev · May 18, 2022 · 9025815 · 9025815
1 parent 7640454
commit 9025815
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 17 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -68,7 +68,7 @@
     "user_guide/message-control": "user_guide/messages/message_control.html",
     "user_guide/messages/messages_introduction": "user_guide/messages/index.html",
     "user_guide/messages/messages_list": "user_guide/messages/messages_overview.html",
-    "additional_commands/index": "user_guide/additional_commands/index.html",
+    "additional_commands/index": "index.html",
 }
 for m in redirects:
     for r in DIRECTORY_REDIRECT:

diff --git a/doc/index.rst b/doc/index.rst
@@ -37,6 +37,12 @@ it's best to start with the ``--errors-only`` flag, then disable
 convention and refactor message with ``--disable=C,R`` and progressively
 re-evaluate and re-enable messages as your priorities evolve.
 
+
+Pylint ships with two additional tools:
+
+- :ref:`pyreverse <pyreverse>` (standalone that generates package and class diagrams.)
+- :ref:`symilar <symilar>`  (duplicate code finder also integrated in pylint)
+
 .. toctree::
    :titlesonly:
    :hidden:
@@ -46,6 +52,8 @@ re-evaluate and re-enable messages as your priorities evolve.
    how_tos/index.rst
    technical_reference/index.rst
    development_guide/index.rst
+   pyreverse
+   symilar
    faq
    contact
    whatsnew/index.rst
diff --git a/...r_guide/additional_commands/pyreverse.rst → doc/pyreverse.rst b/...r_guide/additional_commands/pyreverse.rst → doc/pyreverse.rst
@@ -1,7 +1,10 @@
+.. _pyreverse:
+
 Pyreverse
 ---------
 
 ``pyreverse`` analyzes your source code and generates package and class diagrams.
+
 It supports output to ``.dot``/``.gv``, ``.vcg``, ``.puml``/``.plantuml`` (PlantUML) and ``.mmd``/``.html`` (MermaidJS) file formats.
 If Graphviz (or the ``dot`` command) is installed, all `output formats supported by Graphviz <https://graphviz.org/docs/outputs/>`_
 can be used as well. In this case, ``pyreverse`` first generates a temporary ``.gv`` file, which is then
@@ -28,7 +31,7 @@ Example diagrams generated with the ``.puml`` output format are shown below.
 Class Diagram
 .............
 
-.. image:: ../../media/pyreverse_example_classes.png
+.. image:: media/pyreverse_example_classes.png
    :width: 625
    :height: 589
    :alt: Class diagram generated by pyreverse
@@ -38,7 +41,7 @@ Class Diagram
 Package Diagram
 ...............
 
-.. image:: ../../media/pyreverse_example_packages.png
+.. image:: media/pyreverse_example_packages.png
    :width: 344
    :height: 177
    :alt: Package diagram generated by pyreverse
@@ -57,7 +60,7 @@ For example, running::
 
 will generate the full class and package diagrams for ``pylint``, but will additionally generate a file ``pylint.checkers.classes.ClassChecker.dot``:
 
-.. image:: ../../media/ClassChecker_diagram.png
+.. image:: media/ClassChecker_diagram.png
    :width: 757
    :height: 1452
    :alt: Package diagram generated by pyreverse

diff --git a/...ser_guide/additional_commands/symilar.rst → doc/symilar.rst b/...ser_guide/additional_commands/symilar.rst → doc/symilar.rst
@@ -1,3 +1,5 @@
+.. _symilar:
+
 Symilar
 -------
 

diff --git a/doc/user_guide/additional_commands/index.rst b/doc/user_guide/additional_commands/index.rst
diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst
@@ -8,7 +8,6 @@ User Guide
 
    installation
    run
-   additional_commands/index.rst
    output
    messages/index
    options
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    .. _symilar:
     Symilar
     -------
@@ Expand Down @@