API Documentation is auto-generated and available online at: readthedocs.io. The API documentation for semtk-python3 is build with Sphinx.
To build a local copy of the documentation,
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
mkdir _build
sphinx-build -b html . _build
(Note: on Windows, venv/bin/activate should instead be
venv/Scripts/activate.bat.) You should now have HTML documentation available
in _build/.
NOTE: If you use a different name for your virtual environment folder, you will
need to add it to the exclude_patterns of conf.py, else Sphinx will attempt
to build docs for all Python modules in the virtual environment, and will likely
yield errors such as "Error in currentmodule".
This section is for developers of semtk-python3.
If you add a new module (Python file), you'll need to update the documentation to include it like so:
sphinx-apidoc -Me -H "semtk-python3 API Reference" -d 0 -o api ../semtk3