Changeset a14839a in flex_extract.git for For_developers/Sphinx/source/Developers
- Timestamp:
- May 15, 2020, 2:27:39 PM (4 years ago)
- Branches:
- master, ctbto, dev
- Children:
- f20342a
- Parents:
- b936fd3
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
For_developers/Sphinx/source/Developers/gen_docu.rst
rb1674ed ra14839a 1 1 ******************** 2 Updat e Documentation2 Updating the documentation 3 3 ******************** 4 4 5 5 UNDER CONSTRUCTION 6 6 7 Additional Software7 Additional software 8 8 =================== 9 9 10 Developers working on ``flex_extract`` should make extensive use of the prepared test cases , unit tests andupdate the documentation. For this, some additional software is necessary: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: 11 11 12 12 .. code-block:: sh … … 27 27 28 28 29 On line-documentation with Sphinx29 On-line documentation with Sphinx 30 30 ================================ 31 31 32 Use the scri ot ``gen_docu.sh`` to generate an update of the online documentation of the python component.32 Use the script ``gen_docu.sh`` to generate an update of the on-line documentation of the Python component. 33 33 34 It uses ``pyreverse`` to generate a class and a package diagram with graphvizand overwrites the old files in the developers directory.35 ``pyreverse`` creates ``dot`` files and with the ``dot`` program of the ``graphviz`` softwarethe ``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.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. 36 36 37 37 … … 39 39 ------------------ 40 40 41 You might need to adapt the fonts path for the diagrams to a true 41 You might need to adapt the fonts path for the diagrams to a true-type font. Currently it is set to: 42 42 43 43 .. code-block:: bash … … 50 50 ------------------ 51 51 52 You might need to adapt the fonts path for the diagrams to a true 52 You might need to adapt the fonts path for the diagrams to a true-type font. Currently it is set to: 53 53 54 54 .. code-block:: bash
Note: See TracChangeset
for help on using the changeset viewer.