Skip to content

Commit

Permalink
[doc] Modify the automated redirection to user_guides
Browse files Browse the repository at this point in the history
See discussion: #6628 (comment)

Co-authored-by: Daniël van Noord <[email protected]>
  • Loading branch information
Pierre-Sassoulas and DanielNoord committed May 18, 2022
1 parent 98d9a9f commit 7ade71a
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 5 deletions.
9 changes: 7 additions & 2 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/user_guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ User Guide
==========

.. toctree::
:maxdepth: 3
:maxdepth: 2
:titlesonly:

installation
Expand Down
4 changes: 2 additions & 2 deletions doc/user_guide/messages/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ Messages
########

.. toctree::
:maxdepth: 2
:maxdepth: 1
:hidden:

messages_overview.rst
message-control.rst
message_control.rst

Messages categories
===================
Expand Down
File renamed without changes.

0 comments on commit 7ade71a

Please sign in to comment.