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

15
docs/conf.py Normal file
View file

@ -0,0 +1,15 @@
"""Configure sphinx."""
import lalib
project = lalib.__pkg_name__
author = lalib.__author__
project_copyright = f"2024, {author}"
version = release = lalib.__version__
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"sphinx_autodoc_typehints",
]