view doc/help/README.txt @ 1218:5f59344dbd13

(issue68) License corrections: * the overall package is GNU GPL v==3. * Qt has to be used as GNU GPL, so mention it. * Oxygen is GNU LGPL v>=3. * minor corrections like typos, better phrasing for freedom protection, use GNU consistently.
author Bernhard Reiter <bernhard@intevation.de>
date Wed, 24 Sep 2014 11:17:14 +0200
parents cf1fdb254c41
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/