Mercurial > trustbridge
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 1183:3e4ac23938e1 | 1184:cf1fdb254c41 |
|---|---|
| 1 TrustBridge documentation | |
| 2 ========================= | |
| 3 | |
| 4 The TrustBridge documentation should be build automatically by the | |
| 5 default target in cmake if sphinx is found. | |
| 6 | |
| 7 Requirements on ubuntu 14.4: | |
| 8 python-sphinx | |
| 9 | |
| 10 How to build TrustBridge documentation manually | |
| 11 =============================================== | |
| 12 | |
| 13 The TrustBridge documentation based on Sphinx <http://sphinx-doc.org/>. | |
| 14 Please install the requirements before you build the documentation. | |
| 15 | |
| 16 $ virtualenv .venv | |
| 17 $ . .venv/bin/activate | |
| 18 (.venv) pip install -r requirements.txt | |
| 19 | |
| 20 | |
| 21 Build TrustBridge help pages: | |
| 22 (.venv) cd help-manual | |
| 23 (.venv) make html | |
| 24 | |
| 25 => Open HTML output: _build/html/index.html | |
| 26 | |
| 27 | |
| 28 Build TrustBridge Admin help pages: | |
| 29 (.venv) cd admin-manual | |
| 30 (.venv) make html | |
| 31 | |
| 32 => Open HTML output: _build/html/index.html | |
| 33 |