Skip to content

Commit de25d57

Browse files
committed
Use Furo theme for documentation
1 parent a6d100e commit de25d57

3 files changed

Lines changed: 7 additions & 6 deletions

File tree

docs/conf.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,11 @@
3838

3939
# The theme to use for HTML and HTML Help pages. See the documentation for
4040
# a list of builtin themes.
41-
html_theme = 'sphinx_rtd_theme'
41+
html_theme = 'furo'
4242

4343
html_theme_options = {
44-
'collapse_navigation': False,
44+
'top_of_page_buttons': ['edit'],
45+
'source_edit_link': 'https://github.com/Kozea/cssselect2/edit/main/docs/{filename}',
4546
}
4647

4748
# Favicon URL
@@ -55,7 +56,7 @@
5556
# These paths are either relative to html_static_path
5657
# or fully qualified paths (eg. https://...)
5758
html_css_files = [
58-
'https://www.courtbouillon.org/static/docs.css',
59+
'https://www.courtbouillon.org/static/docs-furo.css',
5960
]
6061

6162
# Output file base name for HTML help builder.

docs/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ cssselect2
77

88
.. toctree::
99
:caption: Documentation
10-
:maxdepth: 3
10+
:maxdepth: 2
1111

1212
first_steps
1313
api_reference
1414

1515
.. toctree::
1616
:caption: Extra Information
17-
:maxdepth: 3
17+
:maxdepth: 2
1818

1919
changelog
2020
contribute

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Changelog = 'https://github.com/Kozea/cssselect2/releases'
4040
Donation = 'https://opencollective.com/courtbouillon'
4141

4242
[project.optional-dependencies]
43-
doc = ['sphinx', 'sphinx_rtd_theme']
43+
doc = ['sphinx', 'furo']
4444
test = ['pytest', 'ruff']
4545

4646
[tool.flit.sdist]

0 commit comments

Comments
 (0)