summaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2022-05-15 14:20:51 +0200
committerGitHub <noreply@github.com>2022-05-15 14:20:51 +0200
commit52138e9abfd2d3453bd653a8854fd69a19873573 (patch)
treeb231c8fa4e6e5ebd7c22d53d82e798f4dea87dcd /doc/conf.py
parent39f95c0815b03eadba6b0ce4f1769a3ea59bed5f (diff)
downloadpylint-git-52138e9abfd2d3453bd653a8854fd69a19873573.tar.gz
[Doc] Create a contact section and cleanup the introduction (#6613)
* Add a mechanism for redirection * Upgrade cache so the new requirements are properly installed Co-authored-by: Daniƫl van Noord <13665637+DanielNoord@users.noreply.github.com>
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py31
1 files changed, 21 insertions, 10 deletions
diff --git a/doc/conf.py b/doc/conf.py
index b75ea2e0d..fbd73c664 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -2,16 +2,7 @@
# For details: https://github.com/PyCQA/pylint/blob/main/LICENSE
# Copyright (c) https://github.com/PyCQA/pylint/blob/main/CONTRIBUTORS.txt
-# Pylint documentation build configuration file, created by
-# sphinx-quickstart on Thu Apr 4 20:31:25 2013.
-#
-# This file is execfile()d with the current directory set to its containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
+from __future__ import annotations
import os
import sys
@@ -24,6 +15,18 @@ from datetime import datetime
# The short X.Y version.
from pylint import __version__
+# Pylint documentation build configuration file, created by
+# sphinx-quickstart on Thu Apr 4 20:31:25 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -43,8 +46,16 @@ extensions = [
"pylint_options",
"sphinx.ext.autosectionlabel",
"sphinx.ext.intersphinx",
+ "sphinx_reredirects",
]
+# https://documatt.gitlab.io/sphinx-reredirects/usage.html
+redirects: dict[str, str] = {
+ # "<source>": "<target>"
+ "intro": "index.html",
+ "support": "contact.html",
+}
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]