diff --git a/doc/conf.py b/doc/conf.py index 226873b6b3..58d2ac16ef 100644 --- a/doc/conf.py +++ b/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] = { # "": "" "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. diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst index 739a22fa56..b9c2f728aa 100644 --- a/doc/user_guide/index.rst +++ b/doc/user_guide/index.rst @@ -3,7 +3,7 @@ User Guide ========== .. toctree:: - :maxdepth: 3 + :maxdepth: 2 :titlesonly: installation diff --git a/doc/user_guide/messages/index.rst b/doc/user_guide/messages/index.rst index 0f20e8c1a5..f663c26c9a 100644 --- a/doc/user_guide/messages/index.rst +++ b/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 =================== diff --git a/doc/user_guide/messages/message-control.rst b/doc/user_guide/messages/message_control.rst similarity index 100% rename from doc/user_guide/messages/message-control.rst rename to doc/user_guide/messages/message_control.rst