This Github repository represents ObjectRocket's documentation site, located at http://docs.objectrocket.com. The site is based on the Sphinx documentation generator for Python.
To suggest changes to the documentation, please submit an Issue or Pull Request.
The documentation pages are built using the reStructuredText standard. Github supports RST, so modification via Github's editor is recommended.
Activate your favorite virtualenv or pyenv, and do the following from your terminal:
pip install -r requirements.txt
cd source
make clean html
Your newly built HTML will live under source/_build/html/
. Open source/_build/html/index.html
to see the root page.
Run make clean html
or just make html
from the source
directory whenever you need a new build of the docs.
If you find an issue, please submit the issue in Github directly. Documentation Issues
And as a small thank you if we merge your pull request, we’ll send you a really nice ObjectRocket t-shirt. Just email your github handle, size and postal address to [email protected].
As always, if you need additional assistance, drop us a note at [email protected].