From de7de90a9a927a831c56e4d8cd0f74e9272e0508 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Wed, 18 May 2022 15:12:42 +0200 Subject: [PATCH 1/6] [doc] Fix the link to block disablein useless-import-alias related --- doc/data/messages/u/useless-import-alias/related.rst | 2 +- doc/user_guide/messages/message_control.rst | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/data/messages/u/useless-import-alias/related.rst b/doc/data/messages/u/useless-import-alias/related.rst index 7a37cbee42..4d69fc3236 100644 --- a/doc/data/messages/u/useless-import-alias/related.rst +++ b/doc/data/messages/u/useless-import-alias/related.rst @@ -1,3 +1,3 @@ - `PEP 8, Import Guideline `_ -- `Pylint block-disable `_ +- `Pylint block-disable `_ - `mypy --no-implicit-reexport `_ diff --git a/doc/user_guide/messages/message_control.rst b/doc/user_guide/messages/message_control.rst index 5b893a31cf..33741ee6a4 100644 --- a/doc/user_guide/messages/message_control.rst +++ b/doc/user_guide/messages/message_control.rst @@ -23,6 +23,7 @@ In order to control messages, ``pylint`` accepts the following values: * All the checks with ``all`` +.. _block_disables: Block disables -------------- From 56e8e21cf8155e90ae535ecc8f06feaf15cca10e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Thu, 19 May 2022 10:52:59 +0200 Subject: [PATCH 2/6] Update doc/data/messages/u/useless-import-alias/related.rst --- doc/data/messages/u/useless-import-alias/related.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/data/messages/u/useless-import-alias/related.rst b/doc/data/messages/u/useless-import-alias/related.rst index 4d69fc3236..75fc633aab 100644 --- a/doc/data/messages/u/useless-import-alias/related.rst +++ b/doc/data/messages/u/useless-import-alias/related.rst @@ -1,3 +1,3 @@ - `PEP 8, Import Guideline `_ -- `Pylint block-disable `_ +- :ref:`Pylint block-disable `_ - `mypy --no-implicit-reexport `_ From 470d6eff7094d273ab272fc5385d2e5a3a77dfc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Thu, 19 May 2022 11:01:06 +0200 Subject: [PATCH 3/6] Update doc/data/messages/u/useless-import-alias/related.rst --- doc/data/messages/u/useless-import-alias/related.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/data/messages/u/useless-import-alias/related.rst b/doc/data/messages/u/useless-import-alias/related.rst index 75fc633aab..462e867ba0 100644 --- a/doc/data/messages/u/useless-import-alias/related.rst +++ b/doc/data/messages/u/useless-import-alias/related.rst @@ -1,3 +1,3 @@ - `PEP 8, Import Guideline `_ -- :ref:`Pylint block-disable `_ +- :ref:`Pylint block-disable `_ - `mypy --no-implicit-reexport `_ From ea2dea7ed65f6068c24df828d89350c3755852e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Thu, 19 May 2022 11:05:02 +0200 Subject: [PATCH 4/6] Update doc/data/messages/u/useless-import-alias/related.rst --- doc/data/messages/u/useless-import-alias/related.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/data/messages/u/useless-import-alias/related.rst b/doc/data/messages/u/useless-import-alias/related.rst index 462e867ba0..4693aeeb88 100644 --- a/doc/data/messages/u/useless-import-alias/related.rst +++ b/doc/data/messages/u/useless-import-alias/related.rst @@ -1,3 +1,3 @@ - `PEP 8, Import Guideline `_ -- :ref:`Pylint block-disable `_ +- :ref:`Pylint block-disable ` - `mypy --no-implicit-reexport `_ From c4db1f44f08dafaceebfeb95ec46f0b584601bae Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Thu, 19 May 2022 11:09:03 +0200 Subject: [PATCH 5/6] [doc] Remove innacurate warning (?) --- doc/conf.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 7b0fd30a4d..a6a8da2549 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -47,7 +47,9 @@ # Single file redirects are handled in this file and can be done by a pylint -# contributor if no englobing full directory redirect is applied first. See: +# contributor. They need to redirect from the directory of the source See: +# I. e. messages/index.html to a/b/c.html will be messages/a/b/c.html not +# a/b/c.html # 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: @@ -61,15 +63,12 @@ "intro": "index.html", "support": "contact.html", "user_guide/ide-integration": "installation.html", - "user_guide/message-control": "user_guide/messages/message_control.html", "additional_commands/index": "../index.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": "messages/message_control.html", } -for m in redirects: - for r in DIRECTORY_REDIRECT: - assert not m.startswith(r), ( - f"Redirection will silentely fail: '{m}' start with '{r}' and " - "the whole directory is redirected by ReadtheDoc conf already." - ) # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] From 39882ccab13182378ef1a3a51c3bb5b54b4310c2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Thu, 19 May 2022 11:38:59 +0200 Subject: [PATCH 6/6] Revert changes --- doc/conf.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index a6a8da2549..7b0fd30a4d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -47,9 +47,7 @@ # Single file redirects are handled in this file and can be done by a pylint -# contributor. They need to redirect from the directory of the source See: -# I. e. messages/index.html to a/b/c.html will be messages/a/b/c.html not -# a/b/c.html +# contributor if no englobing full directory redirect is applied first. 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: @@ -63,12 +61,15 @@ "intro": "index.html", "support": "contact.html", "user_guide/ide-integration": "installation.html", + "user_guide/message-control": "user_guide/messages/message_control.html", "additional_commands/index": "../index.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": "messages/message_control.html", } +for m in redirects: + for r in DIRECTORY_REDIRECT: + assert not m.startswith(r), ( + f"Redirection will silentely fail: '{m}' start with '{r}' and " + "the whole directory is redirected by ReadtheDoc conf already." + ) # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"]