view manuals/README.txt @ 980:491327689ffc

(issue89) Fix typo in HTMLFILES_IMG variable name
author Andre Heinecke <andre.heinecke@intevation.de>
date Fri, 29 Aug 2014 16:00:38 +0200
parents 53f704422fac
children
line wrap: on
line source
TrustBridge documentation
=========================

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

Requirements on ubuntu 14.4:
python-sphinx

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/