view manuals/README.txt @ 903:b5a49960d5cb

Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
author Emanuel Schuetze <emanuel@intevation.de>
date Wed, 13 Aug 2014 14:49:25 +0200
parents
children af27328bea9d
line wrap: on
line source
How to build TrustBridge documentation?
=======================================

The TrustBridge documentation based on Sphinx <http://sphinx-doc.org/>.
Please install the requirements before you build the documentation.

  $ virtualenv .venv
  $ . .venv/bin/activate
  (.venv) pip install -r requirements.txt


Build TrustBridge help pages:
  (.venv) cd help-manual
  (.venv) make html

  => Open HTML output: _build/html/index.html


Build TrustBridge Admin help pages:
  (.venv) cd admin-manual
  (.venv) make html

  => Open HTML output: _build/html/index.html

http://wald.intevation.org/projects/trustbridge/