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