Use the furo themes and change default theme (#6084)

This commit is contained in:
Gunung P. Wibisono 2022-04-02 12:59:51 +07:00 committed by GitHub
parent 551981b1ce
commit dfe5419281
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 11 deletions

View File

@ -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.

View File

@ -1,3 +1,3 @@
Sphinx==4.5.0
python-docs-theme==2022.1
furo==2022.3.4
-e .