diff --git a/doc/api.rst b/doc/api.rst index c3c037e70..d7c9699bc 100644 --- a/doc/api.rst +++ b/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 diff --git a/doc/conf.py b/doc/conf.py index d4a71f8c5..6facc84de 100644 --- a/doc/conf.py +++ b/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": """ + + + + """, + "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 --------------------------------------------------- diff --git a/doc/sources.rst b/doc/sources.rst index 3775cba15..91eb6a810 100644 --- a/doc/sources.rst +++ b/doc/sources.rst @@ -177,9 +177,6 @@ Website `1 `__ - 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. diff --git a/pyproject.toml b/pyproject.toml index a81adce80..3bd60ed2c 100644 --- a/pyproject.toml +++ b/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",