diff options
| author | Daniel Schadt <kingdread@gmx.de> | 2022-12-29 16:20:18 +0100 |
|---|---|---|
| committer | Daniel Schadt <kingdread@gmx.de> | 2022-12-29 16:20:18 +0100 |
| commit | 28d44ca764955cb042e5d1821ffc23e2b9aba07c (patch) | |
| tree | 2aa45eb096dca2a18baf0b43a3a0deabfbdea88f /doc | |
| parent | 75368c69f45b2995e1adcd58795f5c33fbf5b9b3 (diff) | |
| download | fietsboek-28d44ca764955cb042e5d1821ffc23e2b9aba07c.tar.gz fietsboek-28d44ca764955cb042e5d1821ffc23e2b9aba07c.tar.bz2 fietsboek-28d44ca764955cb042e5d1821ffc23e2b9aba07c.zip | |
generate & build API docs for the Python package
We have so many nice docstrings, but they aren't really rendered
anywhere (expect locally in your IDE), as we did not include the API
docs anywhere.
This change uses sphinx-apidoc to generate autodoc stubs for Sphinx, so
that the docstrings are actually rendered to HTML. This is not perfect
yet (I'm not too happy about the default modules.rst simply listing one
package), but it is good enough for the start and makes it possible to
actually browse the docstrings in a browser.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 1 | ||||
| -rw-r--r-- | doc/developer.rst | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/doc/conf.py b/doc/conf.py index 7769cf1..d2d3cf3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -30,6 +30,7 @@ author = 'Daniel Schadt' extensions = [ 'sphinx.ext.autodoc', 'sphinx.ext.intersphinx', + 'sphinx_autodoc_typehints', ] intersphinx_mapping = { diff --git a/doc/developer.rst b/doc/developer.rst index b47b0a4..f6546ab 100644 --- a/doc/developer.rst +++ b/doc/developer.rst @@ -7,6 +7,7 @@ Developer Guide developer/localize developer/language-pack + Python Packages <developer/module/modules> This guide contains information for developers that want to modify or extend Fietsboek. This includes information on how to localize Fietsboek to new |