Skip to content

Documentation source files of the Growler framework

Notifications You must be signed in to change notification settings

pyGrowler/GrowlerDocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Growler Documentation

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.git

Building

Building 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 html

Note, GROWLER_PATH should contain the growler source package (the folder with setup.py), NOT point directly at it (the folder with __init__.py)

License

A license for the documentation has not been chosen yet.

About

Documentation source files of the Growler framework

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published