Merge pull request #30 from CourtBouillon/furo

Use Furo theme for documentation

Author: liZe

docs/conf.py

@@ -40,10 +40,25 @@
 
 # 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 @@
 # 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.

docs/index.rst

@@ -7,7 +7,7 @@ pydyf
 
 .. toctree::
    :caption: Documentation
-   :maxdepth: 3
+   :maxdepth: 2
 
    first_steps
    common_use_cases
@@ -16,7 +16,7 @@ pydyf
 
 .. toctree::
    :caption: Extra Information
-   :maxdepth: 3
+   :maxdepth: 2
 
    changelog
    contribute

pyproject.toml

@@ -38,7 +38,7 @@ Changelog = 'https://github.com/CourtBouillon/pydyf/releases'
 Donation = 'https://opencollective.com/courtbouillon'
 
 [project.optional-dependencies]
-doc = ['sphinx', 'sphinx_rtd_theme']
+doc = ['sphinx', 'furo']
 test = ['pytest', 'ruff', 'pillow']
 
 [tool.flit.sdist]