Skip to content

Commit

Permalink
Install and use insegel as the docs theme
Browse files Browse the repository at this point in the history
  • Loading branch information
purefunctor committed Jun 26, 2021
1 parent 8389ec3 commit 65815f5
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Expand Up @@ -11,4 +11,4 @@
"sphinx_rtd_theme",
]
autodoc_typehints = "description"
html_theme = "sphinx_rtd_theme"
html_theme = "insegel"
2 changes: 1 addition & 1 deletion docs/requirements.txt
@@ -1,2 +1,2 @@
sphinx==4.0.2
sphinx-rtd-theme==0.5.2
insegel==1.1.0
4 changes: 2 additions & 2 deletions noxfile.py
Expand Up @@ -101,7 +101,7 @@ def mypy(session: Session) -> None:
def docs_build(session: Session) -> None:
"""Build documentation."""
args = session.posargs or ["docs", "docs/_build"]
session.install("sphinx", "sphinx-rtd-theme", ".")
session.install("sphinx", "insegel", ".")

build_dir = Path("docs", "_build")
if build_dir.exists():
Expand All @@ -114,7 +114,7 @@ def docs_build(session: Session) -> None:
def docs_live(session: nox.Session) -> None:
"""Build documentation with live reloading."""
args = session.posargs or ["--open-browser", "docs", "docs/_build"]
session.install("sphinx", "sphinx-autobuild", "sphinx-rtd-theme", ".")
session.install("sphinx", "sphinx-autobuild", "insegel", ".")

build_dir = Path("docs", "_build")
if build_dir.exists():
Expand Down
62 changes: 42 additions & 20 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Expand Up @@ -23,7 +23,7 @@ pre-commit = "^2.13.0"
pytest = "^6.2.4"
pytest-mock = "^3.6.1"
sphinx-autobuild = "^2021.3.14"
sphinx-rtd-theme = "^0.5.2"
insegel = "^1.1.0"

[tool.coverage.run]
branch = true
Expand Down

0 comments on commit 65815f5

Please sign in to comment.