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:
parent
0a85e60b51
commit
c07a9ed19f
8 changed files with 608 additions and 2 deletions
15
docs/conf.py
Normal file
15
docs/conf.py
Normal 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",
|
||||
]
|
||||
Loading…
Add table
Add a link
Reference in a new issue