Skip to content
This repository was archived by the owner on Apr 13, 2023. It is now read-only.

Use furo Sphinx theme for documentation #529

Merged
merged 1 commit into from
Nov 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
10 changes: 3 additions & 7 deletions docs/reference.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
Reference
=========

.. contents::
:local:
:backlinks: none

git_portfolio
-------------

git_portfolio.__main__
----------------------

.. automodule:: git_portfolio.__main__
.. automodule:: git_portfolio
:members:
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
furo==2021.11.12
sphinx==4.3.0
sphinx-click==3.0.2
4 changes: 2 additions & 2 deletions noxfile.py
Original file line number Diff line number Diff line change
Expand Up @@ -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():
Expand All @@ -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():
Expand Down
Loading