From 93f44d4ec8c74fb47d3f09ea4a07db0bd97e2d31 Mon Sep 17 00:00:00 2001 From: Guillaume Ayoub Date: Tue, 14 Jan 2025 17:16:51 +0100 Subject: [PATCH] Use Furo theme for documentation --- docs/conf.py | 21 ++++++++++++++++++--- docs/index.rst | 4 ++-- pyproject.toml | 2 +- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 71cd098b..3f1c455a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -40,10 +40,25 @@ pygments_style = 'monokai' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinx_rtd_theme' +html_theme = 'furo' html_theme_options = { - 'collapse_navigation': False, + 'light_css_variables': { + 'color-brand-primary': 'var(--red)', + 'color-brand-content': 'var(--red)', + 'color-brand-visited': 'var(--red)', + 'font-stack': 'ClarityCity, sans-serif', + 'font-stack--monospace': 'Inconsolata, monospace', + 'font-stack--headings': 'Inconsolata, monospace', + }, + 'dark_css_variables': { + 'color-brand-primary': 'var(--red)', + 'color-brand-content': 'var(--red)', + 'color-brand-visited': 'var(--red)', + }, + 'top_of_page_buttons': ['edit'], + 'source_edit_link': + 'https://github.com/CourtBouillon/pydyf/edit/main/docs/{filename}', } # Favicon URL @@ -57,7 +72,7 @@ html_static_path = [] # These paths are either relative to html_static_path # or fully qualified paths (eg. https://...) html_css_files = [ - 'https://www.courtbouillon.org/static/docs.css', + 'https://www.courtbouillon.org/static/docs-furo.css', ] # Output file base name for HTML help builder. diff --git a/docs/index.rst b/docs/index.rst index c558c2ed..fc0ea624 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,7 +7,7 @@ WeasyPrint .. toctree:: :caption: Documentation - :maxdepth: 3 + :maxdepth: 2 first_steps common_use_cases @@ -16,7 +16,7 @@ WeasyPrint .. toctree:: :caption: Extra Information - :maxdepth: 3 + :maxdepth: 2 changelog contribute diff --git a/pyproject.toml b/pyproject.toml index 745701a7..9a5ebfd4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -52,7 +52,7 @@ Changelog = 'https://github.com/Kozea/WeasyPrint/releases' Donation = 'https://opencollective.com/courtbouillon' [project.optional-dependencies] -doc = ['sphinx', 'sphinx_rtd_theme'] +doc = ['sphinx', 'furo'] test = ['pytest', 'ruff'] [project.scripts]