ctbtodev
Last change
on this file since a14839a was
a14839a,
checked in by Petra Seibert <petra.seibert [at) univie.ac.at>, 4 years ago
|
Language corrections for the Sections Developers, Support, Changelog, and the home directory (index.html)
|
-
Property mode set to
100644
|
File size:
1.9 KB
|
Rev | Line | |
---|
[41c9dbc] | 1 | ******************** |
---|
[a14839a] | 2 | Updating the documentation |
---|
[41c9dbc] | 3 | ******************** |
---|
| 4 | |
---|
| 5 | UNDER CONSTRUCTION |
---|
| 6 | |
---|
[a14839a] | 7 | Additional software |
---|
[41c9dbc] | 8 | =================== |
---|
| 9 | |
---|
[a14839a] | 10 | Developers working on ``flex_extract`` should make extensive use of the prepared test cases and unit tests, and should also update the documentation. For this, some additional software is necessary: |
---|
[41c9dbc] | 11 | |
---|
[b1674ed] | 12 | .. code-block:: sh |
---|
| 13 | |
---|
| 14 | pip install pylint |
---|
| 15 | pip install pytest |
---|
| 16 | pip install mock |
---|
| 17 | pip install graphviz |
---|
| 18 | pip install sphinx |
---|
| 19 | pip install sphinxcontrib-exceltable |
---|
| 20 | pip install seqdiag |
---|
| 21 | pip install sphinxcontrib-seqdiag |
---|
| 22 | pip install sphinxcontrib-blockdiag |
---|
| 23 | pip install pycallgraph |
---|
| 24 | |
---|
[0b00607] | 25 | |
---|
[41c9dbc] | 26 | |
---|
| 27 | |
---|
| 28 | |
---|
[a14839a] | 29 | On-line documentation with Sphinx |
---|
[41c9dbc] | 30 | ================================ |
---|
| 31 | |
---|
[a14839a] | 32 | Use the script ``gen_docu.sh`` to generate an update of the on-line documentation of the Python component. |
---|
[41c9dbc] | 33 | |
---|
[a14839a] | 34 | It uses ``pyreverse`` to generate class and package diagrams with ``graphviz`` and overwrites the old files in the developers directory. |
---|
| 35 | ``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. |
---|
[41c9dbc] | 36 | |
---|
| 37 | |
---|
[0b00607] | 38 | Sequence diagramms |
---|
| 39 | ------------------ |
---|
| 40 | |
---|
[a14839a] | 41 | You might need to adapt the fonts path for the diagrams to a true-type font. Currently it is set to: |
---|
[0b00607] | 42 | |
---|
| 43 | .. code-block:: bash |
---|
| 44 | |
---|
| 45 | # Fontpath for seqdiag (truetype font) |
---|
| 46 | seqdiag_fontpath = '/usr/share/fonts/dejavu/DejaVuSerif.ttf' |
---|
| 47 | |
---|
| 48 | |
---|
| 49 | Block diagramms |
---|
| 50 | ------------------ |
---|
| 51 | |
---|
[a14839a] | 52 | You might need to adapt the fonts path for the diagrams to a true-type font. Currently it is set to: |
---|
[0b00607] | 53 | |
---|
| 54 | .. code-block:: bash |
---|
| 55 | |
---|
| 56 | # Fontpath for blockdiag (truetype font) |
---|
| 57 | blockdiag_fontpath = '/usr/share/fonts/dejavu/DejaVuSerif.ttf' |
---|
| 58 | |
---|
[41c9dbc] | 59 | |
---|
| 60 | |
---|
| 61 | |
---|
| 62 | .. toctree:: |
---|
| 63 | :hidden: |
---|
[0b00607] | 64 | :maxdepth: 2 |
---|
Note: See
TracBrowser
for help on using the repository browser.