Use sphinx-rtd-theme & update sphinx (#597)

hacf-fr · Oct 19, 2023 · 5d8546f · 5d8546f
1 parent 01b9755
commit 5d8546f
Show file tree

Hide file tree

Showing 4 changed files with 61 additions and 26 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
 sphinx==7.2.6
+sphinx-rtd-theme==1.3.0
diff --git a/noxfile.py b/noxfile.py
@@ -172,7 +172,7 @@ def docs_build(session: Session) -> None:
     """Build the documentation."""
     args = session.posargs or ["docs", "docs/_build"]
     session.install(".")
-    session.install("sphinx", "sphinx-click")
+    session.install("sphinx", "sphinx-click", "sphinx-rtd-theme")
 
     build_dir = Path("docs", "_build")
     if build_dir.exists():
@@ -186,7 +186,7 @@ def docs(session: Session) -> None:
     """Build and serve the documentation with live reloading on file changes."""
     args = session.posargs or ["--open-browser", "docs", "docs/_build"]
     session.install(".")
-    session.install("sphinx", "sphinx-autobuild", "sphinx-click")
+    session.install("sphinx", "sphinx-autobuild", "sphinx-click", "sphinx-rtd-theme")
 
     build_dir = Path("docs", "_build")
     if build_dir.exists():

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -40,7 +40,7 @@ safety = "^2.3.5"
 mypy = "^1.6"
 typeguard = "^4.1.5"
 xdoctest = {extras = ["colors"], version = "^1.1.1"}
-sphinx = "^4.2.0"
+sphinx = "^7.1.0"
 sphinx-autobuild = "^2021.3.14"
 pre-commit = "^3.5.0"
 flake8 = "^5.0.4"
@@ -53,6 +53,7 @@ pep8-naming = "^0.13.3"
 darglint = "^1.8.1"
 reorder-python-imports = "^3.9.0"
 pre-commit-hooks = "^4.4.0"
+sphinx-rtd-theme = "^1.3.0"
 
 [tool.poetry.scripts]
 freebox_api = "freebox_api.__main__:main"