source: flex_extract.git/documentation/Sphinx/build/html/_sources/index.rst.txt @ 708c667

ctbtodev
Last change on this file since 708c667 was 708c667, checked in by Anne Philipp <anne.philipp@…>, 6 years ago

generated first sphinx instance and adapted code doctsrings for automated api generation for disaggregation module as a first test

  • Property mode set to 100644
File size: 3.2 KB
Line 
1.. flex_extract documentation master file, created by
2   sphinx-quickstart on Wed Oct 17 18:39:05 2018.
3   You can adapt this file completely to your liking, but it should at least
4   contain the root `toctree` directive.
5
6Welcome to flex_extract's documentation!
7========================================
8.. raw:: html
9
10    <table style="width:100%;">
11      <tr>
12        <td style="width:200px;height:150px;">
13          <div style="width:200px;height:100px;">
14          <img style="width:100px;vertical-align: bottom;" src="_static/download_icon.png">
15          </div>
16          <h2>Downloads</h2>
17          <ul>
18            <li><a href="">Download Tar-ball</a></li>
19            <li><a href="">Git repository</a></li>
20            <li><a href="">History of Changes</a></li>
21          </ul>
22        </td>       
23        <td style="width:200px;height:150px;">
24          <div style="width:200px;height:100px;">
25          <img style="width:125px;vertical-align: bottom;" src="_static/prog_icon.png">
26          </div>
27          <h2>Program Structure</h2>
28          <ul>
29          <li><a href="">Overview</a></li>
30          <li><a href="">Program components</a></li>
31          <li><a href="">Program flow</a></li>
32          </ul>
33        </td>
34      </tr>
35      <tr>   
36        <td style="width:200px;height:150px;">
37          <div style="width:200px;height:100px;">
38          <img style="width:100px;vertical-align: bottom;" src="_static/install_icon.png">
39          </div>
40          <h2>Installation</h2>
41          <ul>
42          <li><a href="requirements.html">Requirements</a></li>
43          <li><a href="">Different operation modes</a></li>
44          <li><a href="">Test the installation</a></li>
45          </ul>
46        </td>       
47        <td style="width:200px;height:150px;">
48          <div style="width:200px;height:100px;">
49          <img style="width:100px;vertical-align: bottom;" src="_static/guide_icon.png">
50          </div>
51          <h2>User Guide</h2>
52          <ul>
53          <li><a href="">How to use</a></li>
54          <li><a href="">Control templates</a></li>
55          </ul>
56        </td>
57      </tr>
58      <tr>
59        <td style="width:200px;height:150px;">
60          <div style="width:200px;height:100px;">
61          <img style="width:125px;vertical-align: bottom;" src="_static/api_icon.png">
62          </div>
63          <h2>API Index</h2>
64          <ul>
65          <li><a href="">Construction</a></li>
66          </ul>
67        </td>
68        <td style="width:200px;height:150px;">
69          <div style="width:200px;height:100px;">
70          <img style="width:100px;vertical-align: bottom;" src="_static/help_icon.png">
71          </div>
72          <h2>Support</h2>
73          <ul>
74            <li><a href="">Ticket system</a></li>
75            <li><a href="">Mailing list</a></li>
76            <li><a href="">Known bugs or issues</a></li>
77            <li><a href="">FAQ</a></li>
78          </ul>
79        </td>
80      </tr>
81    </table>
82    <p></p>
83   
84.. note::
85 
86   License text put in here! Which one?
87
88.. toctree::
89   :maxdepth: 2
90   :caption: Table of Contents:
91
92   downloads
93   installation
94   program_structure
95   user_guide
96   api
97   support
98   
99
100Indices and tables
101==================
102
103* :ref:`genindex`
104* :ref:`modindex`
105* :ref:`search`
106
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG