Mercurial > trustbridge
view doc/help/README.txt @ 1255:2a1aa9df8f11
(issue133) Improve API documentation
author | Andre Heinecke <andre.heinecke@intevation.de> |
---|---|
date | Thu, 25 Sep 2014 17:58:12 +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