From 4c52b975873abaa2cfa5edc9f507244cdeb2ef45 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 22 May 2022 10:18:39 +0200 Subject: [PATCH 1/2] Move c-extensions to user guides where it belong --- doc/conf.py | 1 + doc/technical_reference/index.rst | 4 +--- doc/technical_reference/startup.rst | 1 + doc/{technical_reference => user_guide}/c_extensions.rst | 0 doc/user_guide/index.rst | 1 + 5 files changed, 4 insertions(+), 3 deletions(-) rename doc/{technical_reference => user_guide}/c_extensions.rst (100%) diff --git a/doc/conf.py b/doc/conf.py index f4e794cb10..3ba256dcbb 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -61,6 +61,7 @@ "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", + "technical_reference/c_extensions": "../user_guide/c_extensions.html", } # Add any paths that contain templates here, relative to this directory. diff --git a/doc/technical_reference/index.rst b/doc/technical_reference/index.rst index cf3a3a65f2..1d38f4701b 100644 --- a/doc/technical_reference/index.rst +++ b/doc/technical_reference/index.rst @@ -4,10 +4,9 @@ Technical Reference =================== .. TODO Configuration - .. TODO Messages - .. TODO Reports +.. extensions.rst and features.rst are generated. .. toctree:: :maxdepth: 2 @@ -17,4 +16,3 @@ Technical Reference checkers extensions features - c_extensions diff --git a/doc/technical_reference/startup.rst b/doc/technical_reference/startup.rst index 92913ef7fd..a46978a3d8 100644 --- a/doc/technical_reference/startup.rst +++ b/doc/technical_reference/startup.rst @@ -1,5 +1,6 @@ Startup and the Linter Class ---------------------------- + The two main classes in :mod:`pylint.lint` are :class:`.pylint.lint.Run` and :class:`.pylint.lint.PyLinter`. diff --git a/doc/technical_reference/c_extensions.rst b/doc/user_guide/c_extensions.rst similarity index 100% rename from doc/technical_reference/c_extensions.rst rename to doc/user_guide/c_extensions.rst diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst index b9c2f728aa..f5b37eb671 100644 --- a/doc/user_guide/index.rst +++ b/doc/user_guide/index.rst @@ -8,6 +8,7 @@ User Guide installation run + c_extensions output messages/index options From 102196e36d2ff9001bc0a28a606ab254e3be86b8 Mon Sep 17 00:00:00 2001 From: Pierre Sassoulas Date: Sun, 22 May 2022 10:30:47 +0200 Subject: [PATCH 2/2] Update doc/user_guide/index.rst MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> --- doc/user_guide/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user_guide/index.rst b/doc/user_guide/index.rst index f5b37eb671..d32742ee0e 100644 --- a/doc/user_guide/index.rst +++ b/doc/user_guide/index.rst @@ -8,8 +8,8 @@ User Guide installation run + output c_extensions - output messages/index options ide_integration/ide-integration