ctbtodev
|
Last change
on this file since 41c9dbc was
41c9dbc,
checked in by Anne Philipp <anne.philipp@…>, 5 years ago
|
|
Large update of Sphinx doc; moved Sphinx source to dev dir; Cleaned control files
|
-
Property mode set to
100644
|
|
File size:
1.1 KB
|
| Rev | Line | |
|---|
| [41c9dbc] | 1 | ******************** |
|---|
| 2 | Update Documentation |
|---|
| 3 | ******************** |
|---|
| 4 | |
|---|
| 5 | UNDER CONSTRUCTION |
|---|
| 6 | |
|---|
| 7 | Additional Software |
|---|
| 8 | =================== |
|---|
| 9 | |
|---|
| 10 | Developers working on ``flex_extract`` should make extensive use of the prepared test cases, unit tests and update the documentation. For this, some additional software is necessary: |
|---|
| 11 | |
|---|
| 12 | - pylint |
|---|
| 13 | - pytest |
|---|
| 14 | - mock |
|---|
| 15 | - graphviz |
|---|
| 16 | - sphinx |
|---|
| 17 | |
|---|
| 18 | |
|---|
| 19 | |
|---|
| 20 | Online-documentation with Sphinx |
|---|
| 21 | ================================ |
|---|
| 22 | |
|---|
| 23 | Use the scriot ``gen_docu.sh`` to generate an update of the online documentation of the python component. |
|---|
| 24 | |
|---|
| 25 | It uses ``pyreverse`` to generate a class and a package diagram with graphviz and overwrites the old files in the developers directory. |
|---|
| 26 | ``pyreverse`` creates ``dot`` files and with the ``dot`` program of the ``graphviz`` software the ``png`` files are created. Everything happens in the Python source directory before moving them finally to the ``for_developers`` directory. The Sphinx source code has a ``_files`` directory which contains links to these ``png`` files and therefore they should not be renamed. |
|---|
| 27 | |
|---|
| 28 | |
|---|
| 29 | |
|---|
| 30 | |
|---|
| 31 | |
|---|
| 32 | .. toctree:: |
|---|
| 33 | :hidden: |
|---|
| 34 | :maxdepth: 2 |
|---|
Note: See
TracBrowser
for help on using the repository browser.
