Set up a documentation tool

- use sphinx to document the developed package
- create nox session "docs" to build the docs
This commit is contained in:
Alexander Hess 2024-09-10 02:09:09 +02:00
commit c07a9ed19f
Signed by: alexander
GPG key ID: 344EA5AB10D868E0
8 changed files with 608 additions and 2 deletions

View file

@ -59,6 +59,13 @@ pep8-naming = "^0.14" # flake8 plug-in
pydoclint = { extras = ["flake8"], version = "^0.5" }
ruff = "^0.6"
# Documentation
sphinx = [
{ python = "=3.9", version = "^7.4" },
{ python = ">=3.10", version = "^8.0" },
]
sphinx-autodoc-typehints = "^2.3"
# Test suite
coverage = "^7.6"
packaging = "^24.1" # to test the version identifier
@ -376,6 +383,9 @@ known-first-party = ["lalib"]
[tool.ruff.lint.per-file-ignores]
# The "docs/" folder is not a package
"docs/conf.py" = ["INP001"]
"tests/*.py" = [ # Linting rules for the test suite:
"ANN", # - type hints are not required
"S101", # - `assert`s are normal