summaryrefslogtreecommitdiff
path: root/doc/exts
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2022-05-23 20:40:40 +0200
committerGitHub <noreply@github.com>2022-05-23 20:40:40 +0200
commit8d59af69529e89e7ad0871320374a8b6e4dbe86d (patch)
treeca01c06155e226a8cac5ed18df52571b1a182db5 /doc/exts
parent3e6000af9d4600598a3fe71d0053bbc6cac02887 (diff)
downloadpylint-git-8d59af69529e89e7ad0871320374a8b6e4dbe86d.tar.gz
Reorganize the documentation table of content (#6589)
* [doc] Reorganize the doc table of content with four levels User, developer, contributor, maintainer. Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
Diffstat (limited to 'doc/exts')
-rwxr-xr-xdoc/exts/pylint_extensions.py6
-rwxr-xr-xdoc/exts/pylint_features.py2
-rw-r--r--doc/exts/pylint_options.py1
3 files changed, 3 insertions, 6 deletions
diff --git a/doc/exts/pylint_extensions.py b/doc/exts/pylint_extensions.py
index 15511a662..ce10fa637 100755
--- a/doc/exts/pylint_extensions.py
+++ b/doc/exts/pylint_extensions.py
@@ -47,12 +47,10 @@ def builder_inited(app: Optional[Sphinx]) -> None:
linter.load_plugin_modules(modules)
extensions_doc = os.path.join(
- base_path, "doc", "technical_reference", "extensions.rst"
+ base_path, "doc", "user_guide", "checkers", "extensions.rst"
)
with open(extensions_doc, "w", encoding="utf-8") as stream:
- stream.write(
- get_rst_title("Optional Pylint checkers in the extensions module", "=")
- )
+ stream.write(get_rst_title("Optional checkers", "="))
stream.write("Pylint provides the following optional plugins:\n\n")
for module in modules:
stream.write(f"- :ref:`{module}`\n")
diff --git a/doc/exts/pylint_features.py b/doc/exts/pylint_features.py
index 097577c29..9faac95bd 100755
--- a/doc/exts/pylint_features.py
+++ b/doc/exts/pylint_features.py
@@ -26,7 +26,7 @@ def builder_inited(app: Optional[Sphinx]) -> None:
)
linter = PyLinter()
linter.load_default_plugins()
- features = os.path.join(base_path, "doc", "technical_reference", "features.rst")
+ features = os.path.join(base_path, "doc", "user_guide", "checkers", "features.rst")
with open(features, "w", encoding="utf-8") as stream:
stream.write("Pylint features\n")
stream.write("===============\n\n")
diff --git a/doc/exts/pylint_options.py b/doc/exts/pylint_options.py
index 4a6e743ef..e6bd60b43 100644
--- a/doc/exts/pylint_options.py
+++ b/doc/exts/pylint_options.py
@@ -150,7 +150,6 @@ def _write_options_page(options: OptionsDataDict, linter: PyLinter) -> None:
) as stream:
stream.write(
f"""
-{get_rst_title("All pylint options", "=")}
{sections_string}
"""