[doc] Modify the automated redirection to user_guides

See discussion: #6628 (comment)

Co-authored-by: Daniël van Noord <[email protected]>

Author: Pierre-Sassoulas

doc/conf.py

@@ -45,16 +45,21 @@
     "sphinx_reredirects",
 ]
 
+
+# Single file redirects are handled in this file and can be done by a pylint
+# contributor. See:
 # https://documatt.gitlab.io/sphinx-reredirects/usage.html
+# Directory redirects are handled in ReadTheDoc admin interface and can only be done
+# by pylint maintainers at the following URL:
+# https://readthedocs.org/dashboard/pylint/redirects/
 redirects: dict[str, str] = {
     # "<source>": "<target>"
     "intro": "index.html",
     "support": "contact.html",
     "user_guide/ide-integration": "installation.html",
-    "messages/index": "user_guide/messages/index.html",
     "messages/messages_introduction": "user_guide/messages/index.html",
     "messages/messages_list": "user_guide/messages/messages_overview.html",
-    "user_guide/message-control": "user_guide/messages/message-control.html",
+    "user_guide/message-control": "user_guide/messages/message_control.html",
 }
 
 # Add any paths that contain templates here, relative to this directory.

doc/user_guide/index.rst

@@ -3,7 +3,7 @@ User Guide
 ==========
 
 .. toctree::
-   :maxdepth: 3
+   :maxdepth: 2
    :titlesonly:
 
    installation

doc/user_guide/messages/index.rst

@@ -5,11 +5,11 @@ Messages
 ########
 
 .. toctree::
-  :maxdepth: 2
+  :maxdepth: 1
   :hidden:
 
   messages_overview.rst
-  message-control.rst
+  message_control.rst
 
 Messages categories
 ===================