Skip to content
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

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

About

User documentation for eSpaces

Resources

Releases

No releases published

Packages

No packages published

Languages