Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch the theme to 'furo' #679

Merged
merged 3 commits into from
Jun 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo']
extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx_copybutton']
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
todo_include_todos = True

Expand Down Expand Up @@ -93,11 +93,8 @@
# -- Options for HTML output ---------------------------------------------------

# Use the upstream python-docs-theme
html_theme = 'python_docs_theme'
html_theme_options = {
'collapsiblesidebar': True,
'issues_url': 'https://github.com/python/devguide/issues/new',
}
html_theme = 'furo'
html_theme_options = {}


# The name for this set of Sphinx documents. If None, it defaults to
Expand All @@ -107,13 +104,6 @@
# Path to find HTML templates.
templates_path = ['tools/templates']

# Custom sidebar templates, filenames relative to this file.
html_sidebars = {
# Defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars
# Removes the quick search block
'**': ['localtoc.html', 'globaltoc.html', 'relations.html', 'customsourcelink.html'],
}

# Additional static files.
html_static_path = ['tools/static']

Expand All @@ -122,7 +112,7 @@

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
html_logo = "python-logo.png"

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
Expand Down
Binary file added python-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 2 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
Sphinx==3.5.4
python-docs-theme==2021.5
furo
sphinx_copybutton