Skip to content

Commit 4acd84e

Browse files
committed
Use furo sphinx doc theme
1 parent c342260 commit 4acd84e

File tree

3 files changed

+9
-12
lines changed

3 files changed

+9
-12
lines changed

Makefile

+1
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ init_docs:
1111
cd docs; sphinx-quickstart
1212

1313
docs:
14+
python -m pip install furo
1415
sphinx-build docs docs/html
1516

1617
install:

docs/conf.py

+7-12
Original file line numberDiff line numberDiff line change
@@ -20,24 +20,19 @@
2020
"https://cryptography.io/en/latest": "https://cryptography.io/en/latest/objects.inv",
2121
"https://www.pyopenssl.org/en/stable": "https://www.pyopenssl.org/en/stable/objects.inv",
2222
}
23+
templates_path = [""]
2324

2425
if "readthedocs.org" in os.getcwd().split("/"):
2526
with open("index.rst", "w") as fh:
2627
fh.write("Documentation for this project has moved to https://xml-security.github.io/" + project)
2728
else:
28-
import guzzle_sphinx_theme
29-
30-
html_theme_path = guzzle_sphinx_theme.html_theme_path()
31-
html_theme = "guzzle_sphinx_theme"
32-
html_theme_options = {
33-
"project_nav_name": project,
34-
"projectlink": "https://github.com/XML-Security/" + project,
35-
}
29+
html_theme = "furo"
3630
html_sidebars = {
3731
"**": [
38-
"logo-text.html",
39-
# "globaltoc.html",
40-
"localtoc.html",
41-
"searchbox.html",
32+
"sidebar/brand.html",
33+
"sidebar/search.html",
34+
"sidebar/scroll-start.html",
35+
"toc.html",
36+
"sidebar/scroll-end.html",
4237
]
4338
}

docs/toc.html

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{{toc}}

0 commit comments

Comments
 (0)