Skip to content

Commit d7ccc67

Browse files
Pierre-SassoulasPierre-Sassoulas
committed
Move extension/feature documentation in user guide
1 parent 3d311ca commit d7ccc67

File tree

9 files changed

+20
-30
lines changed

9 files changed

+20
-30
lines changed

‎.gitignore

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ doc/user_guide/messages/fatal/
1717
doc/user_guide/messages/information/
1818
doc/user_guide/messages/refactor/
1919
doc/user_guide/messages/warning/
20-
doc/developer_guide/technical_reference/extensions.rst
21-
doc/developer_guide/technical_reference/features.rst
20+
doc/user_guide/extensions.rst
21+
doc/user_guide/features.rst
2222
doc/user_guide/configuration/all-options.rst
2323
pyve
2424
build-stamp

‎doc/developer_guide/technical_reference/index.rst

-8
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,12 @@
33
Technical Reference
44
===================
55

6-
.. TODO Configuration
7-
8-
.. TODO Messages
9-
10-
.. TODO Reports
11-
126
.. toctree::
137
:maxdepth: 2
148
:titlesonly:
159

1610
startup
1711
custom_checkers
18-
extensions
19-
features
2012
plugins
2113
transform_plugins
2214
profiling

‎doc/exts/pylint_extensions.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,7 @@ def builder_inited(app: Optional[Sphinx]) -> None:
4646
linter = PyLinter()
4747
linter.load_plugin_modules(modules)
4848

49-
extensions_doc = os.path.join(
50-
base_path, "doc", "developer_guide", "technical_reference", "extensions.rst"
51-
)
49+
extensions_doc = os.path.join(base_path, "doc", "user_guide", "extensions.rst")
5250
with open(extensions_doc, "w", encoding="utf-8") as stream:
5351
stream.write(
5452
get_rst_title("Optional Pylint checkers in the extensions module", "=")

‎doc/exts/pylint_features.py

+1-3
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ def builder_inited(app: Optional[Sphinx]) -> None:
2424
)
2525
linter = PyLinter()
2626
linter.load_default_plugins()
27-
features = os.path.join(
28-
base_path, "doc", "developer_guide", "technical_reference", "features.rst"
29-
)
27+
features = os.path.join(base_path, "doc", "user_guide", "features.rst")
3028
with open(features, "w", encoding="utf-8") as stream:
3129
stream.write("Pylint features\n")
3230
stream.write("===============\n\n")

‎doc/faq.rst

-4
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,6 @@ The best way to tackle pylint's verboseness is to:
6262
``generate-toml-config`` you can create a piece of ``.toml`` text to put
6363
in your ``pyproject.toml`` file.
6464

65-
.. _bug reports, feedback:
66-
67-
68-
6965

7066
2. Installation
7167
===============

‎doc/intro.rst

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ standard, and tries to enforce a coding style.
1111

1212
Bug reports, feedback
1313
---------------------
14+
.. _bug reports, feedback:
1415

1516
You think you have found a bug in Pylint? Well, this may be the case
1617
since Pylint and python are under heavy development!

‎doc/user_guide/index.rst

+5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
User Guide
22
==========
33

4+
.. TODO Configuration
5+
.. TODO Reports
6+
47
.. toctree::
58
:maxdepth: 2
69
:titlesonly:
710

811
installation
912
tutorial
1013
run
14+
extensions
15+
features
1116
additional_commands/index.rst
1217
messages/index.rst
1318
output

‎doc/user_guide/messages/index.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Messages
66
Pylint can emit various messages. These are categorized according
77
to categories corresponding to bit-encoded exit codes:
88

9-
* Fatal :ref:`Fatal` (1)
10-
* Error :ref:`Error` (2)
11-
* Warning :ref:`Warning` (4)
12-
* Convention :ref:`Convention` (8)
13-
* Refactor :ref:`Refactor` (16)
14-
* Information :ref:`Information` (NA)
9+
* Fatal :ref:`Fatal <user_guide/messages/messages_list:Fatal>` (1)
10+
* Error :ref:`Error <user_guide/messages/messages_list:Error>` (2)
11+
* Warning :ref:`Warning <user_guide/messages/messages_list:Warning>` (4)
12+
* Convention :ref:`Convention <user_guide/messages/messages_list:Convention>` (8)
13+
* Refactor :ref:`Refactor <user_guide/messages/messages_list:Refactor>` (16)
14+
* Information :ref:`Information <user_guide/messages/messages_list:Information>` (NA)
1515

1616
A list of these messages can be found in :ref:`messages-list`
1717

@@ -22,10 +22,10 @@ Disabling messages
2222
to enable / disable a message either from the command line or from the configuration
2323
file, as well as from the code itself.
2424

25-
For more detail see :ref:`messages_control`
25+
For more detail see :ref:`message_control`
2626

2727
.. toctree::
2828
:maxdepth: 1
2929

30-
messages_list.rst
31-
message_control.rst
30+
messages_list
31+
message_control

‎doc/user_guide/whatsnew/2.9.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ new checks optional is a step in that direction. In order to do that we
1919
created an optional code style checker that can be loaded using
2020
``pylint.extensions.code_style`` with the ``load-plugins`` options.
2121
More than ever, if as a veteran you want the most checks you can possibly get,
22-
`you should check the list of pylint extensions. <https://pylint.pycqa.org/en/latest/technical_reference/extensions.html#optional-pylint-checkers-in-the-extensions-module>`_.
22+
`you should check the list of pylint extensions. <https://pylint.pycqa.org/en/latest/user_guide/extensions.html#optional-pylint-checkers-in-the-extensions-module>`_.
2323

2424

2525
New checkers

0 commit comments

Comments
 (0)