Mercurial > trustbridge
annotate doc/help/README.txt @ 1331:8897c90b8166
(issue108) Remove generate_cppcheck and cppcheck target
This did not work correctly. It is better just to manually
execute cppcheck on the files as it gives you more control over
the options.
| author | Andre Heinecke <andre.heinecke@intevation.de> |
|---|---|
| date | Wed, 15 Oct 2014 13:24:59 +0200 |
| parents | cf1fdb254c41 |
| children |
| rev | line source |
|---|---|
|
933
af27328bea9d
(issue89) Add sphinx integration for the build system.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
903
diff
changeset
|
1 TrustBridge documentation |
|
af27328bea9d
(issue89) Add sphinx integration for the build system.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
903
diff
changeset
|
2 ========================= |
|
af27328bea9d
(issue89) Add sphinx integration for the build system.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
903
diff
changeset
|
3 |
|
af27328bea9d
(issue89) Add sphinx integration for the build system.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
903
diff
changeset
|
4 The TrustBridge documentation should be build automatically by the |
|
af27328bea9d
(issue89) Add sphinx integration for the build system.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
903
diff
changeset
|
5 default target in cmake if sphinx is found. |
|
af27328bea9d
(issue89) Add sphinx integration for the build system.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
903
diff
changeset
|
6 |
|
936
53f704422fac
Make absolte directories out of doc references. Update manual readme.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
933
diff
changeset
|
7 Requirements on ubuntu 14.4: |
|
53f704422fac
Make absolte directories out of doc references. Update manual readme.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
933
diff
changeset
|
8 python-sphinx |
|
53f704422fac
Make absolte directories out of doc references. Update manual readme.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
933
diff
changeset
|
9 |
|
933
af27328bea9d
(issue89) Add sphinx integration for the build system.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
903
diff
changeset
|
10 How to build TrustBridge documentation manually |
|
af27328bea9d
(issue89) Add sphinx integration for the build system.
Andre Heinecke <andre.heinecke@intevation.de>
parents:
903
diff
changeset
|
11 =============================================== |
|
903
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
12 |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
13 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
|
14 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
|
15 |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
16 $ virtualenv .venv |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
17 $ . .venv/bin/activate |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
18 (.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
|
19 |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
20 |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
21 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
|
22 (.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
|
23 (.venv) make html |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
24 |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
25 => 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
|
26 |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
27 |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
28 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
|
29 (.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
|
30 (.venv) make html |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
31 |
|
b5a49960d5cb
Added first draft of manuals for TrustBridge and TrustBridge Admin (using Sphinx).
Emanuel Schuetze <emanuel@intevation.de>
parents:
diff
changeset
|
32 => 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
|
33 |