Skip to content

Commit dfe5419

Browse files
authored
Use the furo themes and change default theme (#6084)
1 parent 551981b commit dfe5419

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

doc/conf.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,18 @@
103103

104104
# The theme to use for HTML and HTML Help pages. See the documentation for
105105
# a list of builtin themes.
106-
html_theme = "python_docs_theme"
106+
html_theme = "furo"
107107

108108
# Theme options are theme-specific and customize the look and feel of a theme
109109
# further. For a list of options available for each theme, see the
110110
# documentation.
111-
html_theme_options = {
112-
"collapsiblesidebar": True,
113-
"issues_url": "https://github.com/pycqa/pylint/issues/new",
114-
"root_name": "PyCQA",
115-
"root_url": "https://meta.pycqa.org/en/latest/",
116-
}
111+
# TO-DO: Disable thme options too see how Furo themes look in default config
112+
# html_theme_options = {
113+
# "collapsiblesidebar": True,
114+
# "issues_url": "https://github.com/pycqa/pylint/issues/new",
115+
# "root_name": "PyCQA",
116+
# "root_url": "https://meta.pycqa.org/en/latest/",
117+
# }
117118

118119
# Add any paths that contain custom themes here, relative to this directory.
119120
# html_theme_path = []
@@ -146,9 +147,10 @@
146147
smartquotes = False
147148

148149
# Custom sidebar templates, maps document names to template names.
149-
html_sidebars = {
150-
"**": ["localtoc.html", "globaltoc.html", "relations.html", "sourcelink.html"]
151-
}
150+
# Use Default Furo Sidebar
151+
# html_sidebars = {
152+
# "**": ["localtoc.html", "globaltoc.html", "relations.html", "sourcelink.html"]
153+
# }
152154

153155
# Additional templates that should be rendered to pages, maps page names to
154156
# template names.

doc/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Sphinx==4.5.0
2-
python-docs-theme==2022.1
2+
furo==2022.3.4
33
-e .

0 commit comments

Comments
 (0)