source: flex_extract.git/documentation/Sphinx/build/html/index.html @ 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: 8.9 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8 
9  <meta name="viewport" content="width=device-width, initial-scale=1.0">
10 
11  <title>Welcome to flex_extract’s documentation! &mdash; flex_extract 7.1 alpha documentation</title>
12 
13
14 
15 
16 
17 
18
19 
20
21 
22 
23   
24
25 
26
27  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
28  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
29    <link rel="index" title="Index" href="genindex.html" />
30    <link rel="search" title="Search" href="search.html" />
31    <link rel="next" title="Downloads" href="downloads.html" /> 
32
33 
34  <script src="_static/js/modernizr.min.js"></script>
35
36</head>
37
38<body class="wy-body-for-nav">
39
40   
41  <div class="wy-grid-for-nav">
42
43   
44    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
45      <div class="wy-side-scroll">
46        <div class="wy-side-nav-search">
47         
48
49         
50            <a href="#" class="icon icon-home"> flex_extract
51         
52
53         
54          </a>
55
56         
57           
58           
59              <div class="version">
60                7.1
61              </div>
62           
63         
64
65         
66<div role="search">
67  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
68    <input type="text" name="q" placeholder="Search docs" />
69    <input type="hidden" name="check_keywords" value="yes" />
70    <input type="hidden" name="area" value="default" />
71  </form>
72</div>
73
74         
75        </div>
76
77        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
78         
79           
80           
81             
82           
83           
84              <p class="caption"><span class="caption-text">Table of Contents:</span></p>
85<ul>
86<li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li>
87<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
88<li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li>
89<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
90<li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li>
91<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
92</ul>
93
94           
95         
96        </div>
97      </div>
98    </nav>
99
100    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
101
102     
103      <nav class="wy-nav-top" aria-label="top navigation">
104       
105          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
106          <a href="#">flex_extract</a>
107       
108      </nav>
109
110
111      <div class="wy-nav-content">
112       
113        <div class="rst-content">
114       
115         
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131<div role="navigation" aria-label="breadcrumbs navigation">
132
133  <ul class="wy-breadcrumbs">
134   
135      <li><a href="#">Docs</a> &raquo;</li>
136       
137      <li>Welcome to flex_extract’s documentation!</li>
138   
139   
140      <li class="wy-breadcrumbs-aside">
141       
142           
143            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
144         
145       
146      </li>
147   
148  </ul>
149
150 
151  <hr/>
152</div>
153          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
154           <div itemprop="articleBody">
155           
156  <div class="section" id="welcome-to-flex-extract-s-documentation">
157<h1>Welcome to flex_extract’s documentation!<a class="headerlink" href="#welcome-to-flex-extract-s-documentation" title="Permalink to this headline"></a></h1>
158<table style="width:100%;">
159  <tr>
160    <td style="width:200px;height:150px;">
161      <div style="width:200px;height:100px;">
162      <img style="width:100px;vertical-align: bottom;" src="_static/download_icon.png">
163      </div>
164      <h2>Downloads</h2>
165      <ul>
166        <li><a href="">Download Tar-ball</a></li>
167        <li><a href="">Git repository</a></li>
168        <li><a href="">History of Changes</a></li>
169      </ul>
170    </td>
171    <td style="width:200px;height:150px;">
172      <div style="width:200px;height:100px;">
173      <img style="width:125px;vertical-align: bottom;" src="_static/prog_icon.png">
174      </div>
175      <h2>Program Structure</h2>
176      <ul>
177      <li><a href="">Overview</a></li>
178      <li><a href="">Program components</a></li>
179      <li><a href="">Program flow</a></li>
180      </ul>
181    </td>
182  </tr>
183  <tr>
184    <td style="width:200px;height:150px;">
185      <div style="width:200px;height:100px;">
186      <img style="width:100px;vertical-align: bottom;" src="_static/install_icon.png">
187      </div>
188      <h2>Installation</h2>
189      <ul>
190      <li><a href="requirements.html">Requirements</a></li>
191      <li><a href="">Different operation modes</a></li>
192      <li><a href="">Test the installation</a></li>
193      </ul>
194    </td>
195    <td style="width:200px;height:150px;">
196      <div style="width:200px;height:100px;">
197      <img style="width:100px;vertical-align: bottom;" src="_static/guide_icon.png">
198      </div>
199      <h2>User Guide</h2>
200      <ul>
201      <li><a href="">How to use</a></li>
202      <li><a href="">Control templates</a></li>
203      </ul>
204    </td>
205  </tr>
206  <tr>
207    <td style="width:200px;height:150px;">
208      <div style="width:200px;height:100px;">
209      <img style="width:125px;vertical-align: bottom;" src="_static/api_icon.png">
210      </div>
211      <h2>API Index</h2>
212      <ul>
213      <li><a href="">Construction</a></li>
214      </ul>
215    </td>
216    <td style="width:200px;height:150px;">
217      <div style="width:200px;height:100px;">
218      <img style="width:100px;vertical-align: bottom;" src="_static/help_icon.png">
219      </div>
220      <h2>Support</h2>
221      <ul>
222        <li><a href="">Ticket system</a></li>
223        <li><a href="">Mailing list</a></li>
224        <li><a href="">Known bugs or issues</a></li>
225        <li><a href="">FAQ</a></li>
226      </ul>
227    </td>
228  </tr>
229</table>
230<p></p><div class="admonition note">
231<p class="first admonition-title">Note</p>
232<p class="last">License text put in here! Which one?</p>
233</div>
234<div class="toctree-wrapper compound">
235<p class="caption"><span class="caption-text">Table of Contents:</span></p>
236<ul>
237<li class="toctree-l1"><a class="reference internal" href="downloads.html">Downloads</a></li>
238<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
239<li class="toctree-l1"><a class="reference internal" href="program_structure.html">Program Structure</a></li>
240<li class="toctree-l1"><a class="reference internal" href="user_guide.html">User Guide</a></li>
241<li class="toctree-l1"><a class="reference internal" href="api.html">Auto Generated Documentation</a></li>
242<li class="toctree-l1"><a class="reference internal" href="support.html">Support</a></li>
243</ul>
244</div>
245</div>
246<div class="section" id="indices-and-tables">
247<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
248<ul class="simple">
249<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
250<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
251<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
252</ul>
253</div>
254
255
256           </div>
257           
258          </div>
259          <footer>
260 
261    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
262     
263        <a href="downloads.html" class="btn btn-neutral float-right" title="Downloads" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
264     
265     
266    </div>
267 
268
269  <hr/>
270
271  <div role="contentinfo">
272    <p>
273        &copy; Copyright 2018, Anne Philipp and Leopold Haimberger.
274
275    </p>
276  </div>
277  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
278
279</footer>
280
281        </div>
282      </div>
283
284    </section>
285
286  </div>
287 
288
289
290 
291
292    <script type="text/javascript">
293        var DOCUMENTATION_OPTIONS = {
294            URL_ROOT:'./',
295            VERSION:'7.1 alpha',
296            LANGUAGE:'None',
297            COLLAPSE_INDEX:false,
298            FILE_SUFFIX:'.html',
299            HAS_SOURCE:  true,
300            SOURCELINK_SUFFIX: '.txt'
301        };
302    </script>
303      <script type="text/javascript" src="_static/jquery.js"></script>
304      <script type="text/javascript" src="_static/underscore.js"></script>
305      <script type="text/javascript" src="_static/doctools.js"></script>
306      <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
307
308 
309
310  <script type="text/javascript" src="_static/js/theme.js"></script>
311
312  <script type="text/javascript">
313      jQuery(function () {
314          SphinxRtdTheme.Navigation.enable(true);
315      });
316  </script> 
317
318</body>
319</html>
Note: See TracBrowser for help on using the repository browser.
hosted by ZAMG