Merge pull request #147 from khaeru/doc/furo-theme

Change to "furo" Sphinx HTML theme
khaeru · Nov 8, 2024 · fab8e44 · fab8e44
2 parents 36fa2d5 + 49d1265
commit fab8e44
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 17 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -1,12 +1,9 @@
 version: 2
 
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.10"
-  jobs:
-    post_install:
-    - pip install "plotnine != 0.13.0"
+    python: "3.12"
 
 python:
   install:

diff --git a/doc/_static/custom.css b/doc/_static/custom.css
@@ -0,0 +1,3 @@
+.sidebar-brand-text{
+    text-align: center;
+}
diff --git a/doc/_static/hammer-duotone.svg b/doc/_static/hammer-duotone.svg
diff --git a/doc/conf.py b/doc/conf.py
@@ -47,21 +47,36 @@
 
 # -- Options for HTML output -----------------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for a list of
-# builtin themes.
-html_theme = "sphinx_book_theme"
+html_css_files = ["custom.css"]
 
+html_logo = "_static/hammer-duotone.svg"
+
+html_static_path = ["_static"]
+
+html_theme = "furo"
+
+GH_URL = "https://github.com/khaeru/genno"
 html_theme_options = dict(
-    navigation_with_keys=False,  # Silence a warning
-    path_to_docs="doc",
-    repository_url="https://github.com/khaeru/genno",
-    show_navbar_depth=2,
-    use_edit_page_button=True,
-    use_issues_button=True,
-    use_repository_button=True,
-    use_source_button=True,
+    footer_icons=[
+        {
+            "name": "GitHub",
+            "url": GH_URL,
+            "html": """
+                <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                    <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+                </svg>
+            """,
+            "class": "",
+        },
+    ],
+    top_of_page_buttons=["view", "edit"],
+    source_repository=GH_URL,
+    source_branch="main",
+    source_directory="doc/",
 )
 
+html_title = "genno"
+
 # -- Options for genno.compat.sphinx.reference_alias -----------------------------------
 
 # Mapping from expression → replacement.

diff --git a/pyproject.toml b/pyproject.toml
@@ -39,7 +39,7 @@ dependencies = [
 [project.optional-dependencies]
 # Graphviz, for Computer.describe()
 graphviz = ["graphviz"]
-docs = ["IPython", "sphinx-book-theme"]
+docs = ["furo", "IPython"]
 # Specific packages for which compatibility is provided
 plotnine = ["plotnine"]
 pyam = ["pyam-iamc"]