Additional Software

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:

• pylint
• pytest
• mock
• graphviz
• sphinx
• pip install sphinxcontrib-exceltable
• pip install seqdiag
• pip install sphinxcontrib-seqdiag
• pip install sphinxcontrib-blockdiag
• pip install pycallgraph

#- pip install sphinx-fortran

Online-documentation with Sphinx

Use the scriot gen_docu.sh to generate an update of the online documentation of the python component.

It uses pyreverse to generate a class and a package diagram with graphviz and overwrites the old files in the developers directory. 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.

# Fontpath for seqdiag (truetype font)
seqdiag_fontpath = '/usr/share/fonts/dejavu/DejaVuSerif.ttf'

# Fontpath for blockdiag (truetype font)
blockdiag_fontpath = '/usr/share/fonts/dejavu/DejaVuSerif.ttf'

.. toctree::
    :hidden:
    :maxdepth: 2