User documentation for eSpaces
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
source
.gitignore
README.rst
autocompile.py
bootstrap.py
buildout.cfg
pipRequirements.txt

README.rst

User documentation

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 ifconfig sections and the example config in source/conf.py.
  • 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 source/conf.py settings.

Install

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:

./bin/sphinxbuilder

The final path of the rendered documentation is described in the console output.