Merge pull request #421 from staticdev/docs/furo

Use furo Sphinx theme for documentation

Author: staticdev

docs/conf.py

@@ -5,6 +5,6 @@
 project = "Django Sorting Bootstrap"
 author = "Thiago Carvalho D'Ávila"
 copyright = f"{datetime.now().year}, {author}"
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_rtd_theme"]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon"]
 autodoc_typehints = "description"
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"

docs/requirements.txt

@@ -1,2 +1,2 @@
+furo==2021.11.23
 sphinx==4.3.1
-sphinx-rtd-theme==1.0.0

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-rtd-theme")
+    session.install("sphinx", "furo")
 
     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-rtd-theme")
+    session.install("sphinx", "sphinx-autobuild", "furo")
 
     build_dir = Path("docs", "_build")
     if build_dir.exists():

poetry.lock

@@ -53,9 +53,9 @@ flake8-rst-docstrings = "^0.2.3"
 pep8-naming = "^0.12.1"
 pre-commit-hooks = "^4.0.1"
 typeguard = "^2.13.2"
-sphinx-rtd-theme = "^1.0.0"
 coverage = {version = "6.2", extras = ["toml"]}
 pyupgrade = "^2.29.1"
+furo = ">=2021.11.12"
 
 [tool.coverage.paths]
 source = ["src", "*/site-packages"]