Python documentation with sphinx
Scan directory univention
for Python modules and generate .rst
files in directory sphinx
:
sphinx-apidoc -o ./sphinx ./univention
Now build the documentation using the module index file as the top-level document:
UNIVENTION_BASECONF=/dev/null PYTHONPATH=~/misc/PYTHONPATH:. sphinx-build \
-C \
-D master_doc=modules \
-D extensions=sphinx.ext.autodoc \
-D autodoc_mock_imports=psutil,samba.auth,samba.samdb,samba.param,ldb \
./sphinx ./out
Written on March 9, 2018