End-user documentation for eSpaces, powered by Plone.
Documentation is available at http://docs.espaces.edu.au, produced after each push to this repository.
About this documentation
- Powered by Sphinx
- Configuration-based documentation: an example of using conditional statments
to build up documentation. Just look for
ifconfigsections and the example config in
- Project-wide substitutions: set key aspects to the documentation like
project name and URL in one location (
source/conf.py) and use the
|substitution|markup accordingly in any document.
- Branchable for different projects: just customise the screenshots and
To install all dependencies and then build the actual documentation, do the following:
python boostrap.py ./bin/buildout ./bin/sphinxbuilder
To re-build the documentation, just run:
The final path of the rendered documentation is described in the console output.