view manuals/README.txt @ 935:e977f7a0e8fd

Cleanup temporary stuff (like shar lockdir) always (even when interrupted) on exit.
author Sascha Wilde <wilde@intevation.de>
date Fri, 22 Aug 2014 18:03:52 +0200
parents af27328bea9d
children 53f704422fac
line wrap: on
line source
TrustBridge documentation
=========================

The TrustBridge documentation should be build automatically by the
default target in cmake if sphinx is found.

How to build TrustBridge documentation manually
===============================================

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/