summaryrefslogtreecommitdiff
path: root/doc/conf.py
diff options
context:
space:
mode:
authorGunung P. Wibisono <55311527+gunungpw@users.noreply.github.com>2022-04-02 12:59:51 +0700
committerGitHub <noreply@github.com>2022-04-02 07:59:51 +0200
commitdfe54192812f5e9dda49e6485bacda39f8fd0029 (patch)
tree6c5f11998a0c4b49fd6b1bbbd881d77aae5c6e29 /doc/conf.py
parent551981b1ceb0b3afd34cd08dd28e1fee299eb7d8 (diff)
downloadpylint-git-dfe54192812f5e9dda49e6485bacda39f8fd0029.tar.gz
Use the `furo themes` and change default theme (#6084)
Diffstat (limited to 'doc/conf.py')
-rw-r--r--doc/conf.py22
1 files changed, 12 insertions, 10 deletions
diff --git a/doc/conf.py b/doc/conf.py
index e53d82c16..6858ce205 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -103,17 +103,18 @@ pygments_style = "sphinx"
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = "python_docs_theme"
+html_theme = "furo"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-html_theme_options = {
- "collapsiblesidebar": True,
- "issues_url": "https://github.com/pycqa/pylint/issues/new",
- "root_name": "PyCQA",
- "root_url": "https://meta.pycqa.org/en/latest/",
-}
+# TO-DO: Disable thme options too see how Furo themes look in default config
+# html_theme_options = {
+# "collapsiblesidebar": True,
+# "issues_url": "https://github.com/pycqa/pylint/issues/new",
+# "root_name": "PyCQA",
+# "root_url": "https://meta.pycqa.org/en/latest/",
+# }
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
@@ -146,9 +147,10 @@ html_last_updated_fmt = "%b %d, %Y"
smartquotes = False
# Custom sidebar templates, maps document names to template names.
-html_sidebars = {
- "**": ["localtoc.html", "globaltoc.html", "relations.html", "sourcelink.html"]
-}
+# Use Default Furo Sidebar
+# html_sidebars = {
+# "**": ["localtoc.html", "globaltoc.html", "relations.html", "sourcelink.html"]
+# }
# Additional templates that should be rendered to pages, maps page names to
# template names.