This is a separate repository containing the documentation files for the growler project. It is intended to be used as a submodule of
growler git repository (in /path/to/growler/docs/).
To pull both code and docs, use
git clone --recursive https://github.com/pyGrowler/growler.gitBuilding requires the sphinx documentation generator. Generating the html should be as simple
as running make html. If this documentation is not located in the growler source, the
path may be specified using the GROWLER_PATH environment variable.
GROWLER_PATH=/path/to/growler make htmlNote, GROWLER_PATH should contain the growler source package (the folder with
setup.py), NOT point directly at it (the folder with __init__.py)
A license for the documentation has not been chosen yet.