Skip to content

Commit 42446e1

Browse files
committed
Use Furo theme for documentation
1 parent c35b34e commit 42446e1

File tree

3 files changed

+21
-6
lines changed

3 files changed

+21
-6
lines changed

docs/conf.py

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,25 @@
4646

4747
# The theme to use for HTML and HTML Help pages. See the documentation for
4848
# a list of builtin themes.
49-
html_theme = 'sphinx_rtd_theme'
49+
html_theme = 'furo'
5050

5151
html_theme_options = {
52-
'collapse_navigation': False,
52+
'light_css_variables': {
53+
'color-brand-primary': 'var(--red)',
54+
'color-brand-content': 'var(--red)',
55+
'color-brand-visited': 'var(--red)',
56+
'font-stack': 'ClarityCity, sans-serif',
57+
'font-stack--monospace': 'Inconsolata, monospace',
58+
'font-stack--headings': 'Inconsolata, monospace',
59+
},
60+
'dark_css_variables': {
61+
'color-brand-primary': 'var(--red)',
62+
'color-brand-content': 'var(--red)',
63+
'color-brand-visited': 'var(--red)',
64+
},
65+
'top_of_page_buttons': ['edit'],
66+
'source_edit_link':
67+
'https://github.com/CourtBouillon/pydyf/edit/main/docs/{filename}',
5368
}
5469

5570
# Favicon URL
@@ -63,7 +78,7 @@
6378
# These paths are either relative to html_static_path
6479
# or fully qualified paths (eg. https://...)
6580
html_css_files = [
66-
'https://www.courtbouillon.org/static/docs.css',
81+
'https://www.courtbouillon.org/static/docs-furo.css',
6782
]
6883

6984
# 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,7 +7,7 @@ tinycss2
77

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

1212
first_steps
1313
common_use_cases
@@ -16,7 +16,7 @@ tinycss2
1616

1717
.. toctree::
1818
:caption: Extra Information
19-
:maxdepth: 3
19+
:maxdepth: 2
2020

2121
changelog
2222
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/tinycss2/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)