Changeset b1674ed in flex_extract.git for For_developers/Sphinx/source/Developers/gen_docu.rst

Timestamp:

Apr 1, 2020, 5:03:13 PM (4 years ago)

Author:

Anne Philipp <anne.philipp@…>

Branches:

master, ctbto, dev

Children:

d78851d, e0005c9

Parents:

50f9ca6

Message:

updated online documentation FIX for tickets #265 and #262

File:

• For_developers/Sphinx/source/Developers/gen_docu.rst (modified) (2 diffs)

For_developers/Sphinx/source/Developers/gen_docu.rst

@@ -10 +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:
 
-- pylint
-- pytest
-- mock
-- graphviz
-- sphinx
-- pip install sphinxcontrib-exceltable
-- pip install seqdiag
-- pip install sphinxcontrib-seqdiag
-- pip install sphinxcontrib-blockdiag
-- pip install pycallgraph
+.. code-block:: sh
 
-#- pip install sphinx-fortran
+  pip install pylint
+  pip install pytest
+  pip install mock
+  pip install graphviz
+  pip install sphinx
+  pip install sphinxcontrib-exceltable
+  pip install seqdiag
+  pip install sphinxcontrib-seqdiag
+  pip install sphinxcontrib-blockdiag
+  pip install pycallgraph
+
+
 
 
@@ -31 +33 @@
 
 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.  
+``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.