From 28d44ca764955cb042e5d1821ffc23e2b9aba07c Mon Sep 17 00:00:00 2001 From: Daniel Schadt Date: Thu, 29 Dec 2022 16:20:18 +0100 Subject: 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. --- doc/conf.py | 1 + doc/developer.rst | 1 + 2 files changed, 2 insertions(+) (limited to 'doc') 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 This guide contains information for developers that want to modify or extend Fietsboek. This includes information on how to localize Fietsboek to new -- cgit v1.2.3