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.

Sign up for GitHub

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

Jump to bottom

Change the documentation theme to Furo #244

Merged
merged 4 commits into from
Jul 7, 2024
Merged

Change the documentation theme to Furo #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
59a199a
Change the documentation theme to Furo
jstasiak Dec 13, 2023
2df9a48
Adapt to the theme
jstasiak Jul 7, 2024
ad625d5
Merge remote-tracking branch 'origin/master' into furo-theme
jstasiak Jul 7, 2024
b871e05
Fix the case
jstasiak Jul 7, 2024
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
8 changes: 1 addition & 7 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
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
Expand Down Expand Up @@ -133,12 +133,6 @@
# typographically correct entities.
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
html_sidebars = {
'index': ('sidebar.html', 'sourcelink.html', 'searchbox.html'),
'**': ('localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'),
}

# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
Expand Down
1 change: 1 addition & 0 deletions requirements-docs.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
# pip install -r requirements-docs.in && pip freeze > requirements-docs.txt
#
# and then modifying the file manually to restrict black and mypy to CPython
furo
sphinx
4 changes: 4 additions & 0 deletions requirements-docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
alabaster==0.7.13
babel==2.14.0
beautifulsoup4==4.12.3
certifi==2024.7.4
charset-normalizer==3.3.2
docutils==0.20.1
furo==2024.5.6
idna==3.7
imagesize==1.4.1
importlib-metadata==7.0.0
Expand All @@ -13,7 +15,9 @@ pygments==2.17.2
pytz==2023.3.post1
requests==2.32.2
snowballstemmer==2.2.0
soupsieve==2.5
sphinx==7.1.2
sphinx-basic-ng==1.0.0b2
sphinxcontrib-applehelp==1.0.4
sphinxcontrib-devhelp==1.0.2
sphinxcontrib-htmlhelp==2.0.1
Expand Down
Loading