Changeset b1674ed in flex_extract.git for Documentation/html/Developers


Ignore:
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:
1 edited

Legend:

Unmodified
Added
Removed

  • Documentation/html/Developers/gen_docu.html

    rba99230 rb1674ed  
    2222   
    2323      <script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    24         <script type="text/javascript" src="../_static/jquery.js"></script>
    25         <script type="text/javascript" src="../_static/underscore.js"></script>
    26         <script type="text/javascript" src="../_static/doctools.js"></script>
    27         <script type="text/javascript" src="../_static/language_data.js"></script>
    28         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
     24        <script src="../_static/jquery.js"></script>
     25        <script src="../_static/underscore.js"></script>
     26        <script src="../_static/doctools.js"></script>
     27        <script src="../_static/language_data.js"></script>
     28        <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
    2929   
    3030    <script type="text/javascript" src="../_static/js/theme.js"></script>
    … …  
    183183<h2>Additional Software<a class="headerlink" href="#additional-software" title="Permalink to this headline">¶</a></h2>
    184184<p>Developers working on <code class="docutils literal notranslate"><span class="pre">flex_extract</span></code> should make extensive use of the prepared test cases, unit tests and update the documentation. For this, some additional software is necessary:</p>
    185 <ul class="simple">
    186 <li>pylint</li>
    187 <li>pytest</li>
    188 <li>mock</li>
    189 <li>graphviz</li>
    190 <li>sphinx</li>
    191 <li>pip install sphinxcontrib-exceltable</li>
    192 <li>pip install seqdiag</li>
    193 <li>pip install sphinxcontrib-seqdiag</li>
    194 <li>pip install sphinxcontrib-blockdiag</li>
    195 <li>pip install pycallgraph</li>
    196 </ul>
    197 <p>#- pip install sphinx-fortran</p>
     185<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>pip install pylint
     186pip install pytest
     187pip install mock
     188pip install graphviz
     189pip install sphinx
     190pip install sphinxcontrib-exceltable
     191pip install seqdiag
     192pip install sphinxcontrib-seqdiag
     193pip install sphinxcontrib-blockdiag
     194pip install pycallgraph
     195</pre></div>
     196</div>
    198197</div>
    199198<div class="section" id="online-documentation-with-sphinx">
    … …  
    201200<p>Use the scriot <code class="docutils literal notranslate"><span class="pre">gen_docu.sh</span></code> to generate an update of the online documentation of the python component.</p>
    202201<p>It uses <code class="docutils literal notranslate"><span class="pre">pyreverse</span></code> to generate a class and a package diagram with graphviz and overwrites the old files in the developers directory.
    203 <code class="docutils literal notranslate"><span class="pre">pyreverse</span></code> creates <code class="docutils literal notranslate"><span class="pre">dot</span></code> files and with the <code class="docutils literal notranslate"><span class="pre">dot</span></code> program of the <code class="docutils literal notranslate"><span class="pre">graphviz</span></code> software the <code class="docutils literal notranslate"><span class="pre">png</span></code> files are created. Everything happens in the Python source directory before moving them finally to the <code class="docutils literal notranslate"><span class="pre">for_developers</span></code> directory. The Sphinx source code has a <code class="docutils literal notranslate"><span class="pre">_files</span></code> directory which contains links to these <code class="docutils literal notranslate"><span class="pre">png</span></code> files and therefore they should not be renamed.</p>
     202<code class="docutils literal notranslate"><span class="pre">pyreverse</span></code> creates <code class="docutils literal notranslate"><span class="pre">dot</span></code> files and with the <code class="docutils literal notranslate"><span class="pre">dot</span></code> program of the <code class="docutils literal notranslate"><span class="pre">graphviz</span></code> software the <code class="docutils literal notranslate"><span class="pre">png</span></code> files are created. Everything happens in the Python source directory before moving them finally to the <code class="docutils literal notranslate"><span class="pre">For_developers</span></code> directory. The Sphinx source code has a <code class="docutils literal notranslate"><span class="pre">_files</span></code> directory which contains links to these <code class="docutils literal notranslate"><span class="pre">png</span></code> files and therefore they should not be renamed.</p>
    204203<div class="section" id="sequence-diagramms">
    205204<h3>Sequence diagramms<a class="headerlink" href="#sequence-diagramms" title="Permalink to this headline">¶</a></h3>
    … …  
    243242  <div role="contentinfo">
    244243    <p>
    245         &copy; Copyright 2019, Anne Philipp and Leopold Haimberger
     244        &copy; Copyright 2020, Anne Philipp and Leopold Haimberger
    246245
    247246    </p>
Note: See TracChangeset for help on using the changeset viewer.
hosted by ZAMG