Nkululeko documentation

Documentation URL: https://nkululeko.readthedocs.io/en/latest/

How to run locally

# Install requirements (from docs directory)
$ pip install -r requirements.txt
$ make html

It assumed that the current working directory is docs/ instead of Nkululeko parent directory. Otherwise, it will install requirements for Nkululeko development, not for building the documentation.

After that, check the built HTML in build/html/index.html

firefox build/html/index.html

Generate RST files from docstring

To generate RST files from docstring, you can use the following command:

sphinx-apidoc -f -o source/ ../nkululeko/

If found any issues, please report them here.