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

Change to furo Sphinx theme

doc/api.rst

@@ -20,6 +20,7 @@ See also the :doc:`implementation`.
 On this page:
 
 .. contents::
+   :class: this-will-duplicate-information-and-it-is-still-useful-here
    :local:
    :depth: 1
    :backlinks: none

doc/conf.py

@@ -36,19 +36,30 @@
 
 # -- Options for HTML output -----------------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.
-html_theme = "sphinx_book_theme"
+GH_URL = "https://github.com/khaeru/sdmx"
+
+html_theme = "furo"
 
 html_theme_options = dict(
-    path_to_docs="doc",
-    repository_url="https://github.com/khaeru/sdmx",
-    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 = "sdmx1"
 
 # -- Options for sphinx.ext.extlinks ---------------------------------------------------
 

doc/sources.rst

@@ -177,9 +177,6 @@ Website `1 <https://wikis.ec.europa.eu/pages/viewpage.action?pageId=40708145>`__
 - Eurostat also maintains four additional SDMX REST API endpoints, available in :mod:`sdmx` with the IDs below.
   These are described at URL (2) above.
 
-.. contents::
-    :local:
-
 - In some cases, the service can have a long response time, so :mod:`sdmx` will time out.
   Increase the timeout attribute if necessary.
 

pyproject.toml

@@ -38,7 +38,7 @@ dependencies = [
 
 [project.optional-dependencies]
 cache = ["requests-cache"]
-docs = ["IPython", "sphinx >=4", "sphinx-book-theme"]
+docs = ["furo", "IPython", "sphinx >= 8"]
 tests = [
   "Jinja2",
   "pytest >= 5",