Installation Guide for BeeWatch¶
You can install the module, build the documentation or do both (advised ;P). If you install the module after you have built the documentation, the documentation is copied to the folder of the installed module.
Install BeeWatch¶
To install BeeWatch run ./setup.py install
in BeeWatch-X.X. For more options run ./setup.py help
or see Distributing on python.org
Build the documentation¶
This project uses Sphinx for documentation generation. Sphinx can create the documentation in a variety of formats, eg html, pdf, epub an more. Run make help
to get a list of supported file formats. Let’s say you chose html, so you run make html
. This creates the documentation inside ‘build/docs/<format>’. The entry point for reading the html version of the docs is build/docs/html/index.html.
Todo
add requirements installation help