Mercurial > trustbridge
diff doc/help/README.txt @ 1184:cf1fdb254c41
Moved help pages from 'manuals' to 'doc/help'.
Updated .hgignore.
author | Emanuel Schuetze <emanuel@intevation.de> |
---|---|
date | Mon, 22 Sep 2014 13:02:11 +0200 |
parents | manuals/README.txt@53f704422fac |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/help/README.txt Mon Sep 22 13:02:11 2014 +0200 @@ -0,0 +1,33 @@ +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 +