aleju / imgaug-doc

Code and assets to generate the documentation of imgaug

imgaug-doc

This repository contains code and assets to generate the documentation of imgaug. The files were moved to their own repository (instead of a folder inside imgaug) as they were starting to become too large -- especially the images.

To generate the docs, first install the necessary packages, e.g. via:

pip install Sphinx numpydoc sphinx_rtd_theme

Then generate the documentation via

make html

When calling make html, the content of this repository (imgaug-doc) must be a folder inside the main repository (imgaug), i.e. something like imgaug/doc where doc contains this repository's content.

Note that when calling make html you will probably get lots of warnings saying WARNING: toctree contains reference to nonexisting document (...). That is normal. Just ignore these messages.