Skip to content

Commit fe8f008

Browse files
committed
Switch documentation theme to Furo
1 parent e182861 commit fe8f008

File tree

2 files changed

+7
-21
lines changed

2 files changed

+7
-21
lines changed

docs/html/conf.py

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,6 @@
128128
# output. They are ignored by default.
129129
# show_authors = False
130130

131-
# The name of the Pygments (syntax highlighting) style to use.
132-
pygments_style = 'sphinx'
133-
134131
# A list of ignored prefixes for module index sorting.
135132
# modindex_common_prefix = []
136133

@@ -147,25 +144,18 @@
147144

148145
# The theme to use for HTML and HTML Help pages. Major themes that come with
149146
# Sphinx are currently 'default' and 'sphinxdoc'.
150-
html_theme = "pypa_theme"
147+
html_theme = "furo"
151148

152149
# Theme options are theme-specific and customize the look and feel of a theme
153150
# further. For a list of options available for each theme, see the
154151
# documentation.
155-
html_theme_options = {
156-
'collapsiblesidebar': True,
157-
'externalrefs': True,
158-
'navigation_depth': 3,
159-
'issues_url': 'https://github.com/pypa/pip/issues',
160-
'codebgcolor': '#eeffcc',
161-
'codetextcolor': '#333333',
162-
}
152+
html_theme_options = {}
163153

164154
# Add any paths that contain custom themes here, relative to this directory.
165155

166156
# The name for this set of Sphinx documents. If None, it defaults to
167157
# "<project> v<release> documentation".
168-
# html_title = None
158+
html_title = f"{project} documentation v{release}"
169159

170160
# A shorter title for the navigation bar. Default is the same as html_title.
171161
# html_short_title = None
@@ -182,7 +172,7 @@
182172
# Add any paths that contain custom static files (such as style sheets) here,
183173
# relative to this directory. They are copied after the builtin static files,
184174
# so a file named "default.css" will overwrite the builtin "default.css".
185-
html_static_path = ['_static']
175+
html_static_path = []
186176

187177
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
188178
# using the given strftime format.
@@ -205,10 +195,7 @@
205195
smartquotes_action = "qe"
206196

207197
# Custom sidebar templates, maps document names to template names.
208-
html_sidebars = {
209-
'**': ['localtoc.html', 'relations.html'],
210-
'index': ['localtoc.html']
211-
}
198+
html_sidebars = {}
212199

213200
# Additional templates that should be rendered to pages, maps page names to
214201
# template names.
@@ -322,7 +309,7 @@ def to_document_name(path, base_dir):
322309
docs_feedback_big_doc_lines = 50 # bigger docs will have a banner on top
323310
docs_feedback_email = 'Docs UX Team <docs-feedback+ux/[email protected]>'
324311
docs_feedback_excluded_documents = { # these won't have any banners
325-
'news',
312+
'news', 'reference/index',
326313
}
327314
docs_feedback_questions_list = (
328315
'What problem were you trying to solve when you came to this page?',

tools/requirements/docs.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
sphinx == 3.2.1
2-
git+https://github.com/python/python-docs-theme.git#egg=python-docs-theme
3-
git+https://github.com/pypa/pypa-docs-theme.git#egg=pypa-docs-theme
2+
furo
43
sphinx-inline-tabs
54

65
# `docs.pipext` uses pip's internals to generate documentation. So, we install

0 commit comments

Comments
 (0)