Skip to content

Commit

Permalink
chg: doc: Automated doc generated.
Browse files Browse the repository at this point in the history
  • Loading branch information
JhnW committed Oct 6, 2024
1 parent df1eb54 commit 4de8da4
Show file tree
Hide file tree
Showing 120 changed files with 5,124 additions and 477 deletions.
16 changes: 16 additions & 0 deletions doc_src/api/devana.utility.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ devana.utility.fakeenum
:undoc-members:
:show-inheritance:

devana.utility.init\_params
---------------------------

.. automodule:: devana.utility.init_params
:members:
:undoc-members:
:show-inheritance:

devana.utility.lazy
-------------------

Expand All @@ -35,6 +43,14 @@ devana.utility.traits
:undoc-members:
:show-inheritance:

devana.utility.typeregister
---------------------------

.. automodule:: devana.utility.typeregister
:members:
:undoc-members:
:show-inheritance:




Expand Down
Binary file modified docs/.doctrees/api/devana.doctree
Binary file not shown.
Binary file modified docs/.doctrees/api/devana.preprocessing.components.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/api/devana.syntax_abstraction.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/api/devana.utility.doctree
Binary file not shown.
Binary file modified docs/.doctrees/changelog_list.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/.doctrees/how_to_start.doctree
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.codeprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.codeprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/codeprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.configuration &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.configuration &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/configuration.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.attributeprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.attributeprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/attributeprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.basictypeprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.basictypeprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/basictypeprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.classprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.classprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/classprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.commentprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.commentprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/commentprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.defaultprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.defaultprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/defaultprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.enumprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.enumprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/enumprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.externcprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.externcprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/externcprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.fileprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.fileprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/fileprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.functionprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.functionprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/functionprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down Expand Up @@ -161,7 +161,10 @@ <h1>Source code for devana.code_generation.printers.default.functionprinter</h1>
<span class="k">if</span> <span class="n">source</span><span class="o">.</span><span class="n">modification</span><span class="o">.</span><span class="n">is_volatile</span><span class="p">:</span>
<span class="n">result</span> <span class="o">+=</span> <span class="s2">&quot; volatile&quot;</span>
<span class="k">if</span> <span class="n">source</span><span class="o">.</span><span class="n">modification</span><span class="o">.</span><span class="n">is_noexcept</span><span class="p">:</span>
<span class="n">result</span> <span class="o">+=</span> <span class="s2">&quot; noexcept&quot;</span>
<span class="k">if</span> <span class="n">source</span><span class="o">.</span><span class="n">modification</span><span class="o">.</span><span class="n">noexcept_value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">result</span> <span class="o">+=</span> <span class="s2">&quot; noexcept&quot;</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">result</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">&quot; noexcept(</span><span class="si">{</span><span class="n">source</span><span class="o">.</span><span class="n">modification</span><span class="o">.</span><span class="n">noexcept_value</span><span class="si">}</span><span class="s2">)&quot;</span>

<span class="k">if</span> <span class="n">source</span><span class="o">.</span><span class="n">modification</span><span class="o">.</span><span class="n">is_default</span><span class="p">:</span>
<span class="n">result</span> <span class="o">+=</span> <span class="s2">&quot; = default&quot;</span>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.functiontypeprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.functiontypeprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/functiontypeprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.namespaceprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.namespaceprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/namespaceprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.stubtypeprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.stubtypeprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/stubtypeprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.templateparameterprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.templateparameterprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/templateparameterprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.typedefprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.typedefprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/typedefprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.typeexpressionprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.typeexpressionprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/typeexpressionprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>devana.code_generation.printers.default.unionprinter &mdash; devana 2.2.1 documentation</title>
<title>devana.code_generation.printers.default.unionprinter &mdash; devana 2.3.0 documentation</title>
<link rel="stylesheet" href="../../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../../_static/css/theme.css" type="text/css" />
<link rel="canonical" href="https://jhnw.github.io/devana/_modules/devana/code_generation/printers/default/unionprinter.html" />
Expand All @@ -30,7 +30,7 @@
<a href="../../../../../index.html" class="icon icon-home"> devana
</a>
<div class="version">
2.2
2.3
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
Expand Down
Loading

0 comments on commit 4de8da4

Please sign in to comment.