feat: Sphinx 8 support (#46)

Author: kai687

docs/conf.py

@@ -17,15 +17,15 @@
 extensions = ["sphinx_docsearch", "myst_parser"]
 myst_enable_extensions = ["colon_fence", "deflist"]
 linkcheck_ignore = ["https://dashboard.algolia.com"]
-
-# Ignore Algolia dashboard links
-linkcheck_ignore = [r"https://dashboard.algolia.com/*"]
+html_show_sourcelink = False
 
 # DocSearch Sphinx extension
 docsearch_app_id = os.getenv("DOCSEARCH_APP_ID")
 docsearch_api_key = os.getenv("DOCSEARCH_API_KEY")
 docsearch_index_name = os.getenv("DOCSEARCH_INDEX_NAME")
 
+tags.add("furo")  # noqa
+
 # Support building the docs with different themes
 # Add `-t alabaster` or `-t rtd` to the build arguments
 if tags.has("rtd"):  # noqa

docs/requirements.txt

@@ -1,63 +1,52 @@
-accessible-pygments==0.0.5 ; python_version >= "3.9" and python_version < "4.0"
+accessible-pygments==0.0.4 ; python_version >= "3.8" and python_version < "4.0"
 alabaster==0.7.13 ; python_version >= "3.8" and python_version < "3.9"
-alabaster==0.7.16 ; python_version >= "3.9" and python_version < "4.0"
-anyio==4.4.0 ; python_version >= "3.9" and python_version < "3.13"
-babel==2.15.0 ; python_version >= "3.8" and python_version < "4.0"
+alabaster==0.7.16 ; python_version >= "3.9" and python_version < "3.10"
+alabaster==1.0.0 ; python_version >= "3.10" and python_version < "4.0"
+babel==2.16.0 ; python_version >= "3.8" and python_version < "4.0"
 beautifulsoup4==4.12.3 ; python_version >= "3.8" and python_version < "4.0"
-certifi==2024.2.2 ; python_version >= "3.8" and python_version < "4.0"
+certifi==2024.8.30 ; python_version >= "3.8" and python_version < "4.0"
 charset-normalizer==3.3.2 ; python_version >= "3.8" and python_version < "4.0"
-click==8.1.7 ; python_version >= "3.9" and python_version < "3.13"
-colorama==0.4.6 ; python_version >= "3.8" and python_version < "4.0" and (python_version < "3.13" or sys_platform == "win32")
+colorama==0.4.6 ; python_version >= "3.8" and python_version < "4.0"
 docutils==0.20.1 ; python_version >= "3.8" and python_version < "4.0"
-exceptiongroup==1.2.1 ; python_version >= "3.9" and python_version < "3.11"
-furo==2024.5.6 ; python_version >= "3.8" and python_version < "4.0"
-h11==0.14.0 ; python_version >= "3.9" and python_version < "3.13"
-idna==3.7 ; python_version >= "3.8" and python_version < "4.0"
+furo==2024.8.6 ; python_version >= "3.8" and python_version < "4.0"
+idna==3.10 ; python_version >= "3.8" and python_version < "4.0"
 imagesize==1.4.1 ; python_version >= "3.8" and python_version < "4.0"
-importlib-metadata==7.1.0 ; python_version >= "3.8" and python_version < "3.10"
+importlib-metadata==8.5.0 ; python_version >= "3.8" and python_version < "3.10"
 jinja2==3.1.4 ; python_version >= "3.8" and python_version < "4.0"
-livereload==2.6.3 ; python_version >= "3.8" and python_version < "3.9"
+livereload==2.7.0 ; python_version >= "3.8" and python_version < "4.0"
 markdown-it-py==3.0.0 ; python_version >= "3.8" and python_version < "4.0"
 markupsafe==2.1.5 ; python_version >= "3.8" and python_version < "4.0"
-mdit-py-plugins==0.4.1 ; python_version >= "3.8" and python_version < "4.0"
+mdit-py-plugins==0.4.2 ; python_version >= "3.8" and python_version < "4.0"
 mdurl==0.1.2 ; python_version >= "3.8" and python_version < "4.0"
-myst-parser==3.0.1 ; python_version >= "3.8" and python_version < "4.0"
-packaging==24.0 ; python_version >= "3.8" and python_version < "4.0"
-pydata-sphinx-theme==0.15.2 ; python_version >= "3.9" and python_version < "4.0"
+myst-parser==3.0.1 ; python_version >= "3.8" and python_version < "3.10"
+myst-parser==4.0.0 ; python_version >= "3.10" and python_version < "4.0"
+packaging==24.1 ; python_version >= "3.8" and python_version < "4.0"
+pydata-sphinx-theme==0.14.4 ; python_version >= "3.8" and python_version < "4.0"
 pygments==2.18.0 ; python_version >= "3.8" and python_version < "4.0"
 python-dotenv==1.0.1 ; python_version >= "3.8" and python_version < "4.0"
-pytz==2024.1 ; python_version >= "3.8" and python_version < "3.9"
-pyyaml==6.0.1 ; python_version >= "3.8" and python_version < "4.0"
-requests==2.32.2 ; python_version >= "3.8" and python_version < "4.0"
-six==1.16.0 ; python_version >= "3.8" and python_version < "3.9"
-sniffio==1.3.1 ; python_version >= "3.9" and python_version < "3.13"
+pytz==2024.2 ; python_version >= "3.8" and python_version < "3.9"
+pyyaml==6.0.2 ; python_version >= "3.8" and python_version < "4.0"
+requests==2.32.3 ; python_version >= "3.8" and python_version < "4.0"
 snowballstemmer==2.2.0 ; python_version >= "3.8" and python_version < "4.0"
-soupsieve==2.5 ; python_version >= "3.8" and python_version < "4.0"
-sphinx-autobuild==2021.3.14 ; python_version >= "3.8" and python_version < "3.9"
-sphinx-autobuild==2024.4.16 ; python_version >= "3.9" and python_version < "3.13"
+soupsieve==2.6 ; python_version >= "3.8" and python_version < "4.0"
+sphinx-autobuild==2021.3.14 ; python_version >= "3.8" and python_version < "4.0"
 sphinx-basic-ng==1.0.0b2 ; python_version >= "3.8" and python_version < "4.0"
-sphinx-rtd-theme==2.0.0 ; python_version >= "3.8" and python_version < "4.0"
 sphinx==7.1.2 ; python_version >= "3.8" and python_version < "3.9"
-sphinx==7.3.7 ; python_version >= "3.9" and python_version < "4.0"
-sphinxawesome-theme==5.1.5 ; python_version >= "3.8" and python_version < "4.0"
+sphinx==7.4.7 ; python_version >= "3.9" and python_version < "3.10"
+sphinx==8.0.2 ; python_version >= "3.10" and python_version < "4.0"
 sphinxcontrib-applehelp==1.0.4 ; python_version >= "3.8" and python_version < "3.9"
-sphinxcontrib-applehelp==1.0.8 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-applehelp==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
 sphinxcontrib-devhelp==1.0.2 ; python_version >= "3.8" and python_version < "3.9"
-sphinxcontrib-devhelp==1.0.6 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-devhelp==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
 sphinxcontrib-htmlhelp==2.0.1 ; python_version >= "3.8" and python_version < "3.9"
-sphinxcontrib-htmlhelp==2.0.5 ; python_version >= "3.9" and python_version < "4.0"
-sphinxcontrib-jquery==4.1 ; python_version >= "3.8" and python_version < "4.0"
+sphinxcontrib-htmlhelp==2.1.0 ; python_version >= "3.9" and python_version < "4.0"
 sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.8" and python_version < "4.0"
 sphinxcontrib-qthelp==1.0.3 ; python_version >= "3.8" and python_version < "3.9"
-sphinxcontrib-qthelp==1.0.7 ; python_version >= "3.9" and python_version < "4.0"
-sphinxcontrib-serializinghtml==1.1.10 ; python_version >= "3.9" and python_version < "4.0"
+sphinxcontrib-qthelp==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
 sphinxcontrib-serializinghtml==1.1.5 ; python_version >= "3.8" and python_version < "3.9"
-starlette==0.37.2 ; python_version >= "3.9" and python_version < "3.13"
-tomli==2.0.1 ; python_version >= "3.9" and python_version < "3.11"
-tornado==6.4 ; python_version >= "3.8" and python_version < "3.9"
-typing-extensions==4.12.0 ; python_version >= "3.9" and python_version < "4.0"
-urllib3==2.2.1 ; python_version >= "3.8" and python_version < "4.0"
-uvicorn==0.30.0 ; python_version >= "3.9" and python_version < "3.13"
-watchfiles==0.22.0 ; python_version >= "3.9" and python_version < "3.13"
-websockets==12.0 ; python_version >= "3.9" and python_version < "3.13"
-zipp==3.19.0 ; python_version >= "3.8" and python_version < "3.10"
+sphinxcontrib-serializinghtml==2.0.0 ; python_version >= "3.9" and python_version < "4.0"
+tomli==2.0.2 ; python_version >= "3.9" and python_version < "3.11"
+tornado==6.4.1 ; python_version >= "3.8" and python_version < "4.0"
+typing-extensions==4.12.2 ; python_version >= "3.8" and python_version < "4.0"
+urllib3==2.2.3 ; python_version >= "3.8" and python_version < "4.0"
+zipp==3.20.2 ; python_version >= "3.8" and python_version < "3.10"

noxfile.py

@@ -36,7 +36,7 @@ def install_with_group(s: Session, group: str = "dev") -> None:
 @session(python=python_versions)
 def docs(s: Session) -> None:
     """Build the docs."""
-    args = ["-aWTE", "docs", "docs/_dist"]
+    args = ["-aWTE", "docs", "docs/_dist", "-t", "furo"]
     sphinx_build = "sphinx-build"
 
     if "--live" in s.posargs: