Merge pull request #529 from staticdev/docs/furo

staticdev · web-flow · commit b0ec16e76c5d · 2021-11-29T20:03:43.000+01:00
Use furo Sphinx theme for documentation
diff --git a/docs/conf.py b/docs/conf.py
@@ -7,3 +7,4 @@
 copyright = f"{datetime.now().year}, {author}"
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.napoleon", "sphinx_click"]
 autodoc_typehints = "description"
+html_theme = "furo"
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -1,13 +1,9 @@
 Reference
 =========
 
-.. contents::
-    :local:
-    :backlinks: none
 
+git_portfolio
+-------------
 
-git_portfolio.__main__
-----------------------
-
-.. automodule:: git_portfolio.__main__
+.. automodule:: git_portfolio
    :members:
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
+furo==2021.11.12
 sphinx==4.3.0
 sphinx-click==3.0.2
diff --git a/noxfile.py b/noxfile.py
@@ -173,7 +173,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", "furo")
 
     build_dir = Path("docs", "_build")
     if build_dir.exists():
@@ -187,7 +187,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", "furo")
 
     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

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,3 @@`
	`1`	`+furo==2021.11.12`
`1`	`2`	`sphinx==4.3.0`
`2`	`3`	`sphinx-click==3.0.2`