Mercurial > trustbridge
comparison manuals/README.txt @ 903:b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
| author | Emanuel Schuetze <emanuel@intevation.de> |
|---|---|
| date | Wed, 13 Aug 2014 14:49:25 +0200 |
| parents | |
| children | af27328bea9d |
comparison
equal
deleted
inserted
replaced
| 902:f5a48c228e9b | 903:b5a49960d5cb |
|---|---|
| 1 How to build TrustBridge documentation? | |
| 2 ======================================= | |
| 3 | |
| 4 The TrustBridge documentation based on Sphinx <http://sphinx-doc.org/>. | |
| 5 Please install the requirements before you build the documentation. | |
| 6 | |
| 7 $ virtualenv .venv | |
| 8 $ . .venv/bin/activate | |
| 9 (.venv) pip install -r requirements.txt | |
| 10 | |
| 11 | |
| 12 Build TrustBridge help pages: | |
| 13 (.venv) cd help-manual | |
| 14 (.venv) make html | |
| 15 | |
| 16 => Open HTML output: _build/html/index.html | |
| 17 | |
| 18 | |
| 19 Build TrustBridge Admin help pages: | |
| 20 (.venv) cd admin-manual | |
| 21 (.venv) make html | |
| 22 | |
| 23 => Open HTML output: _build/html/index.html | |
| 24 |