/usr/share/doc/python-pygccxml-doc/html/design.html is in python-pygccxml-doc 1.8.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Design overview — pygccxml 1.8.0 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="pygccxml 1.8.0 documentation" href="index.html"/>
<link rel="next" title="Who is using pygccxml?" href="users.html"/>
<link rel="prev" title="Declarations query API" href="query_interface.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> pygccxml
</a>
<div class="version">
1.8.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install.html">Download & Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Building the documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="query_interface.html">Declarations query API</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Design overview</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#declarations-package"><code class="docutils literal"><span class="pre">declarations</span></code> package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#types-hierarchy">Types hierarchy</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#type-traits"><code class="docutils literal"><span class="pre">type_traits</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#declarations-hierarchy">Declarations hierarchy</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#parser-package"><code class="docutils literal"><span class="pre">parser</span></code> package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#parser-classes">Parser classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#parser-configuration-classes">Parser configuration classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cache-classes">Cache classes</a></li>
<li class="toctree-l3"><a class="reference internal" href="#patchers">Patchers</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#utils-package"><code class="docutils literal"><span class="pre">utils</span></code> package</a></li>
<li class="toctree-l2"><a class="reference internal" href="#summary">Summary</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="users.html">Who is using pygccxml?</a></li>
<li class="toctree-l1"><a class="reference internal" href="links.html">C++ Reflection</a></li>
<li class="toctree-l1"><a class="reference internal" href="releasing.html">Releasing</a></li>
<li class="toctree-l1"><a class="reference internal" href="history.html">History and Credits</a></li>
<li class="toctree-l1"><a class="reference internal" href="apidocs/api.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="upgrade_issues.html">GCC-XML 0.7 → 0.9 upgrade issues (Legacy)</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pygccxml</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Design overview</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/design.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="design-overview">
<h1>Design overview<a class="headerlink" href="#design-overview" title="Permalink to this headline">¶</a></h1>
<p>pygccxml has 4 packages:</p>
<ul>
<li><p class="first"><a class="reference internal" href="apidocs/declarations.html#module-pygccxml.declarations" title="pygccxml.declarations"><code class="xref py py-mod docutils literal"><span class="pre">declarations</span></code></a></p>
<p>This package defines classes that describe C++ declarations and types.</p>
</li>
<li><p class="first"><a class="reference internal" href="apidocs/parser.html#module-pygccxml.parser" title="pygccxml.parser"><code class="xref py py-mod docutils literal"><span class="pre">parser</span></code></a></p>
<p>This package defines classes that parse <a class="reference external" href="http://www.gccxml.org">GCC-XML</a>
or <a class="reference external" href="https://github.com/CastXML/CastXML">CastXML</a> generated files. It also defines a few classes that will help
you unnecessary parsing of C++ source files.</p>
</li>
<li><p class="first"><a class="reference internal" href="apidocs/binary_parsers.html#module-pygccxml.binary_parsers" title="pygccxml.binary_parsers"><code class="xref py py-mod docutils literal"><span class="pre">binary_parsers</span></code></a></p>
<p>This package extracts information from binary files (<cite>.so</cite>, <cite>.dll</cite>, <cite>.map</cite>)
and merges it with the declarations tree.</p>
</li>
<li><p class="first"><code class="xref py py-mod docutils literal"><span class="pre">utils</span></code></p>
<p>This package defines a few functions useful for the whole project,
but which are mainly used internally by pygccxml.</p>
</li>
</ul>
<div class="section" id="declarations-package">
<h2><code class="docutils literal"><span class="pre">declarations</span></code> package<a class="headerlink" href="#declarations-package" title="Permalink to this headline">¶</a></h2>
<p>Please take a look on the <a class="reference external" href="declarations_uml.png">UML diagram</a>. This <a class="reference external" href="declarations_uml.png">UML diagram</a> describes almost all
classes defined in the package and their relationship. <code class="docutils literal"><span class="pre">declarations</span></code> package
defines two hierarchies of class:</p>
<ol class="arabic simple">
<li>types hierarchy - used to represent a C++ type</li>
<li>declarations hierarchy - used to represent a C++ declaration</li>
</ol>
<div class="section" id="types-hierarchy">
<h3>Types hierarchy<a class="headerlink" href="#types-hierarchy" title="Permalink to this headline">¶</a></h3>
<p>Types hierarchy is used to represent an arbitrary type in C++. class <code class="docutils literal"><span class="pre">type_t</span></code>
is the base class.</p>
<div class="section" id="type-traits">
<h4><code class="docutils literal"><span class="pre">type_traits</span></code><a class="headerlink" href="#type-traits" title="Permalink to this headline">¶</a></h4>
<p>Are you aware of <a class="reference external" href="http://www.boost.org/libs/type_traits/index.html">boost::type_traits</a> library? The <a class="reference external" href="http://www.boost.org/libs/type_traits/index.html">boost::type_traits</a>
library contains a set of very specific traits classes, each of which
encapsulate a single trait from the C++ type system; for example, is a type
a pointer or a reference? Or does a type have a trivial constructor, or a
const-qualifier?</p>
<p>pygccxml implements a lot of functionality from the library:</p>
<ul>
<li><p class="first">a lot of algorithms were implemented</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">is_same</span></code></li>
<li><code class="docutils literal"><span class="pre">is_enum</span></code></li>
<li><code class="docutils literal"><span class="pre">is_void</span></code></li>
<li><code class="docutils literal"><span class="pre">is_const</span></code></li>
<li><code class="docutils literal"><span class="pre">is_array</span></code></li>
<li><code class="docutils literal"><span class="pre">is_pointer</span></code></li>
<li><code class="docutils literal"><span class="pre">is_volatile</span></code></li>
<li><code class="docutils literal"><span class="pre">is_integral</span></code></li>
<li><code class="docutils literal"><span class="pre">is_reference</span></code></li>
<li><code class="docutils literal"><span class="pre">is_arithmetic</span></code></li>
<li><code class="docutils literal"><span class="pre">is_convertible</span></code></li>
<li><code class="docutils literal"><span class="pre">is_fundamental</span></code></li>
<li><code class="docutils literal"><span class="pre">is_floating_point</span></code></li>
<li><code class="docutils literal"><span class="pre">is_base_and_derived</span></code></li>
<li><code class="docutils literal"><span class="pre">is_unary_operator</span></code></li>
<li><code class="docutils literal"><span class="pre">is_binary_operator</span></code></li>
<li><code class="docutils literal"><span class="pre">remove_cv</span></code></li>
<li><code class="docutils literal"><span class="pre">remove_const</span></code></li>
<li><code class="docutils literal"><span class="pre">remove_alias</span></code></li>
<li><code class="docutils literal"><span class="pre">remove_pointer</span></code></li>
<li><code class="docutils literal"><span class="pre">remove_volatile</span></code></li>
<li><code class="docutils literal"><span class="pre">remove_reference</span></code></li>
<li><code class="docutils literal"><span class="pre">has_trivial_copy</span></code></li>
<li><code class="docutils literal"><span class="pre">has_trivial_constructor</span></code></li>
<li><code class="docutils literal"><span class="pre">has_any_non_copyconstructor</span></code></li>
</ul>
<p>For a full list of implemented algorithms, please consult API documentation.</p>
</li>
<li><p class="first">a lot of unit tests has been written base on unit tests from the
<a class="reference external" href="http://www.boost.org/libs/type_traits/index.html">boost::type_traits</a> library.</p>
</li>
</ul>
<p>If you are going to build code generator, you will find <code class="docutils literal"><span class="pre">type_traits</span></code> very handy.</p>
</div>
</div>
<div class="section" id="declarations-hierarchy">
<h3>Declarations hierarchy<a class="headerlink" href="#declarations-hierarchy" title="Permalink to this headline">¶</a></h3>
<p>A declaration hierarchy is used to represent an arbitrary C++ declaration.
Basically, most of the classes defined in this package are just “set of properties”.</p>
<p><code class="docutils literal"><span class="pre">declaration_t</span></code> is the base class of the declaration hierarchy. Every declaration
has <code class="docutils literal"><span class="pre">parent</span></code> property. This property keeps a reference to the scope declaration
instance, in which this declaration is defined.</p>
<p>The <code class="docutils literal"><span class="pre">scopedef_t</span></code> class derives from <code class="docutils literal"><span class="pre">declaration_t</span></code>. This class is used to
say - “I may have other declarations inside”. The “composite” design pattern is
used here. <code class="docutils literal"><span class="pre">class_t</span></code> and <code class="docutils literal"><span class="pre">namespace_t</span></code> declaration classes derive from the
<code class="docutils literal"><span class="pre">scopedef_t</span></code> class.</p>
</div>
</div>
<div class="section" id="parser-package">
<h2><code class="docutils literal"><span class="pre">parser</span></code> package<a class="headerlink" href="#parser-package" title="Permalink to this headline">¶</a></h2>
<p>Please take a look on <a class="reference external" href="parser_uml.png">parser package UML diagram</a> . Classes defined in this
package, implement parsing and linking functionality. There are few kind of
classes defined by the package:</p>
<ul class="simple">
<li>classes, that implements parsing algorithms of <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> generated XML file</li>
<li>parser configuration classes</li>
<li>cache - classes, those one will help you to eliminate unnecessary parsing</li>
<li>patchers - classes, which fix <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> generated declarations. ( Yes, sometimes
GCC-XML generates wrong description of C++ declaration. )</li>
</ul>
<div class="section" id="parser-classes">
<h3>Parser classes<a class="headerlink" href="#parser-classes" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal"><span class="pre">source_reader_t</span></code> - the only class that have a detailed knowledge about <a class="reference external" href="http://www.gccxml.org">GCC-XML</a>.
It has only one responsibility: it calls <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> with a source file specified
by user and creates declarations tree. The implementation of this class is split
to 2 classes:</p>
<ol class="arabic simple">
<li><code class="docutils literal"><span class="pre">scanner_t</span></code> - this class scans the “XML” file, generated by <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> and
creates pygccxml declarations and types classes. After the xml file has
been processed declarations and type class instances keeps references to
each other using <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> generated ids.</li>
<li><code class="docutils literal"><span class="pre">linker_t</span></code> - this class contains logic for replacing <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> generated
ids with references to declarations or type class instances.</li>
</ol>
<p>Both those classes are implementation details and should not be used by user.
Performance note: <code class="docutils literal"><span class="pre">scanner_t</span></code> class uses Python <code class="docutils literal"><span class="pre">xml.sax</span></code> package in order
to parse XML. As a result, <code class="docutils literal"><span class="pre">scanner_t</span></code> class is able to parse even big XML files
pretty quick.</p>
<p><code class="docutils literal"><span class="pre">project_reader_t</span></code> - think about this class as a linker. In most cases you work
with few source files. GCC-XML does not supports this mode of work. So, pygccxml
implements all functionality needed to parse few source files at once.
<code class="docutils literal"><span class="pre">project_reader_t</span></code> implements 2 different algorithms, that solves the problem:</p>
<ol class="arabic simple">
<li><code class="docutils literal"><span class="pre">project_reader_t</span></code> creates temporal source file, which includes all the source
files.</li>
<li><code class="docutils literal"><span class="pre">project_reader_t</span></code> parse separately every source file, using <code class="docutils literal"><span class="pre">source_reader_t</span></code>
class and then joins the resulting declarations tree into single declarations
tree.</li>
</ol>
<p>Both approaches have different trades-off. The first approach does not allow you
to reuse information from already parsed source files. While the second one
allows you to setup cache.</p>
</div>
<div class="section" id="parser-configuration-classes">
<h3>Parser configuration classes<a class="headerlink" href="#parser-configuration-classes" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal"><span class="pre">gccxml_configuration_t</span></code> - a class, that accumulates all the settings needed to invoke <a class="reference external" href="http://www.gccxml.org">GCC-XML</a>:</p>
<p><code class="docutils literal"><span class="pre">file_configuration_t</span></code> - a class, that contains some data and description how
to treat the data. <code class="docutils literal"><span class="pre">file_configuration_t</span></code> can contain reference to the the following types
of data:</p>
<ol class="arabic">
<li><p class="first">path to C++ source file</p>
</li>
<li><p class="first">path to <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> generated XML file</p>
</li>
<li><p class="first">path to C++ source file and path to <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> generated XML file</p>
<p>In this case, if XML file does not exists, it will be created. Next time
you will ask to parse the source file, the XML file will be used instead.</p>
<p>Small tip: you can setup your makefile to delete XML files every time,
the relevant source file has changed.</p>
</li>
<li><p class="first">Python string, that contains valid C++ code</p>
</li>
</ol>
<p>There are few functions that will help you to construct <code class="docutils literal"><span class="pre">file_configuration_t</span></code>
object:</p>
<ul>
<li><p class="first"><code class="docutils literal"><span class="pre">def</span> <span class="pre">create_source_fc(</span> <span class="pre">header</span> <span class="pre">)</span></code></p>
<p><code class="docutils literal"><span class="pre">header</span></code> contains path to C++ source file</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">def</span> <span class="pre">create_gccxml_fc(</span> <span class="pre">xml_file</span> <span class="pre">)</span></code></p>
<p><code class="docutils literal"><span class="pre">xml_file</span></code> contains path to <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> generated XML file</p>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">def</span> <span class="pre">create_cached_source_fc(</span> <span class="pre">header,</span> <span class="pre">cached_source_file</span> <span class="pre">)</span></code></p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">header</span></code> contains path to C++ source file</li>
<li><code class="docutils literal"><span class="pre">xml_file</span></code> contains path to <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> generated XML file</li>
</ul>
</li>
<li><p class="first"><code class="docutils literal"><span class="pre">def</span> <span class="pre">create_text_fc(</span> <span class="pre">text</span> <span class="pre">)</span></code></p>
<p><code class="docutils literal"><span class="pre">text</span></code> - Python string, that contains valid C++ code</p>
</li>
</ul>
</div>
<div class="section" id="cache-classes">
<h3>Cache classes<a class="headerlink" href="#cache-classes" title="Permalink to this headline">¶</a></h3>
<p>There are few cache classes, which implements different cache strategies.</p>
<ol class="arabic simple">
<li><code class="docutils literal"><span class="pre">file_configuration_t</span></code> class, that keeps path to C++ source file and path to
<a class="reference external" href="http://www.gccxml.org">GCC-XML</a> generated XML file.</li>
<li><code class="docutils literal"><span class="pre">file_cache_t</span></code> class, will save all declarations from all files within single
binary file.</li>
<li><code class="docutils literal"><span class="pre">directory_cache_t</span></code> class will store one index file called “index.dat” which
is always read by the cache when the cache object is created. Each header file
will have its corresponding *.cache file that stores the declarations found
in the header file. The index file is used to determine whether a *.cache file
is still valid or not (by checking if one of the dependent files
(i.e. the header file itself and all included files) have been modified since
the last run).</li>
</ol>
<p>In some cases, <code class="docutils literal"><span class="pre">directory_cache_t</span></code> class gives much better performance, than
<code class="docutils literal"><span class="pre">file_cache_t</span></code>. Many thanks to Matthias Baas for its implementation.</p>
<p><strong>Warning</strong>: when pygccxml writes information to files, using cache classes,
it does not write any version information. It means, that when you upgrade
pygccxml you have to delete all your cache files. Otherwise you will get very
strange errors. For example: missing attribute.</p>
</div>
<div class="section" id="patchers">
<h3>Patchers<a class="headerlink" href="#patchers" title="Permalink to this headline">¶</a></h3>
<p>Well, <a class="reference external" href="http://www.gccxml.org">GCC-XML</a> has few bugs, which could not be fixed from it. For example</p>
<div class="highlight-c++"><div class="highlight"><pre><span></span><span class="k">namespace</span> <span class="n">ns1</span><span class="p">{</span> <span class="k">namespace</span> <span class="n">ns2</span><span class="p">{</span>
<span class="k">enum</span> <span class="n">fruit</span><span class="p">{</span> <span class="n">apple</span><span class="p">,</span> <span class="n">orange</span> <span class="p">};</span>
<span class="p">}</span> <span class="p">}</span>
</pre></div>
</div>
<div class="highlight-c++"><div class="highlight"><pre><span></span><span class="kt">void</span> <span class="nf">fix_enum</span><span class="p">(</span> <span class="n">ns1</span><span class="o">::</span><span class="n">ns2</span><span class="o">::</span><span class="n">fruit</span> <span class="n">arg</span><span class="o">=</span><span class="n">ns1</span><span class="o">::</span><span class="n">ns2</span><span class="o">::</span><span class="n">apple</span> <span class="p">);</span>
</pre></div>
</div>
<p><a class="reference external" href="http://www.gccxml.org">GCC-XML</a> will report the default value of <code class="docutils literal"><span class="pre">arg</span></code> as <code class="docutils literal"><span class="pre">apple</span></code>. Obviously
this in an error. pygccxml knows how to fix this bug.</p>
<p>This is not the only bug, which could be fixed, there are few of them. pygccxml
introduces few classes, which knows how to deal with specific bug. More over, those
bugs are fixed, only if I am 101% sure, that this is the right thing to do.</p>
</div>
</div>
<div class="section" id="utils-package">
<h2><code class="docutils literal"><span class="pre">utils</span></code> package<a class="headerlink" href="#utils-package" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div>Use internally by pygccxml.
Some methods/classes may be still usefull: loggers, find_xml_generator</div></blockquote>
</div>
<div class="section" id="summary">
<h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headline">¶</a></h2>
<p>That’s all. I hope I was clear, at least I tried. Any way, pygccxml is an open
source project. You always can take a look on the source code. If you need more
information please read API documentation.</p>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="users.html" class="btn btn-neutral float-right" title="Who is using pygccxml?" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="query_interface.html" class="btn btn-neutral" title="Declarations query API" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014-2016, Insight Software Consortium.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|