Skip to content

Commit 9defead

Browse files
committed
Use sphinx_material theme in the docs
1 parent 4b197bf commit 9defead

File tree

3 files changed

+21
-3
lines changed

3 files changed

+21
-3
lines changed

.readthedocs.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
version: 2
2+
3+
python:
4+
install:
5+
- requirements: docs/requirements.txt

docs/conf.py

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,18 +83,30 @@
8383
# a list of builtin themes.
8484
#
8585
#html_theme = 'alabaster'
86-
html_theme = "sphinx_rtd_theme"
86+
# html_theme = "sphinx_rtd_theme"
8787

8888
# Theme options are theme-specific and customize the look and feel of a theme
8989
# further. For a list of options available for each theme, see the
9090
# documentation.
9191
#
9292
# html_theme_options = {}
93+
# html_theme_options = {
94+
# 'collapse_navigation': False,
95+
# 'navigation_depth': 3
96+
# }
97+
98+
# Setup material template
99+
html_theme = 'sphinx_material'
93100
html_theme_options = {
94-
'collapse_navigation': False,
95-
'navigation_depth': 3
101+
'globaltoc_depth': 3,
102+
'globaltoc_collapse': True,
103+
'color_primary': 'deep-purple',
104+
}
105+
html_sidebars = {
106+
"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
96107
}
97108

109+
98110
# Add any paths that contain custom static files (such as style sheets) here,
99111
# relative to this directory. They are copied after the builtin static files,
100112
# so a file named "default.css" will overwrite the builtin "default.css".

docs/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
sphinxcontrib-httpdomain
2+
sphinx-material

0 commit comments

Comments
 (0)