Skip to content

Commit

Permalink
rebuild doc
Browse files Browse the repository at this point in the history
  • Loading branch information
treyssede committed Mar 27, 2024
1 parent 0dca8a9 commit 001e2a3
Show file tree
Hide file tree
Showing 13 changed files with 2,610 additions and 31 deletions.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/waveguicsx.doctree
View file
Binary file not shown.
3 changes: 2 additions & 1 deletion docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../documentation.html">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../waveguicsx.html">waveguicsx.waveguide</a></li>
<li class="toctree-l2"><a class="reference internal" href="../waveguicsx.html">waveguide.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="../waveguicsx.html#module-waveguicsx.scattering">scattering.py</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../tutorials.html">Tutorials</a><ul>
Expand Down
13 changes: 6 additions & 7 deletions docs/_sources/waveguicsx.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
waveguicsx.waveguide
--------------------

.. automodule:: waveguicsx
:members:
:undoc-members:
:show-inheritance:
waveguide.py
------------

.. automodule:: waveguicsx.waveguide
:members:
:undoc-members:
:show-inheritance:


scattering.py
-------------

.. automodule:: waveguicsx.scattering
:members:
:undoc-members:
Expand Down
192 changes: 192 additions & 0 deletions docs/documentation.html
View file

Large diffs are not rendered by default.

12 changes: 2 additions & 10 deletions docs/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguicsx.waveguide</a></li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguide.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html#module-waveguicsx.scattering">scattering.py</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
Expand Down Expand Up @@ -163,8 +164,6 @@ <h2 id="M">M</h2>
module

<ul>
<li><a href="waveguicsx.html#module-waveguicsx">waveguicsx</a>
</li>
<li><a href="waveguicsx.html#module-waveguicsx.scattering">waveguicsx.scattering</a>
</li>
<li><a href="waveguicsx.html#module-waveguicsx.waveguide">waveguicsx.waveguide</a>
Expand Down Expand Up @@ -263,13 +262,6 @@ <h2 id="W">W</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
waveguicsx

<ul>
<li><a href="waveguicsx.html#module-waveguicsx">module</a>
</li>
</ul></li>
<li>
waveguicsx.scattering

<ul>
Expand Down
8 changes: 6 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguicsx.waveguide</a></li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguide.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html#module-waveguicsx.scattering">scattering.py</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
Expand Down Expand Up @@ -127,7 +128,7 @@ <h1>Waveguicsx - Version 2.1<a class="headerlink" href="#waveguicsx-version-vers
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguicsx.waveguide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguide.py</a><ul>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide"><code class="docutils literal notranslate"><span class="pre">Waveguide</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.set_parameters"><code class="docutils literal notranslate"><span class="pre">Waveguide.set_parameters()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Waveguide.solve"><code class="docutils literal notranslate"><span class="pre">Waveguide.solve()</span></code></a></li>
Expand Down Expand Up @@ -164,6 +165,9 @@ <h1>Waveguicsx - Version 2.1<a class="headerlink" href="#waveguicsx-version-vers
<li class="toctree-l4"><a class="reference internal" href="waveguicsx.html#waveguicsx.waveguide.Signal.plot_spectrum"><code class="docutils literal notranslate"><span class="pre">Signal.plot_spectrum()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html#module-waveguicsx.scattering">scattering.py</a><ul>
<li class="toctree-l3"><a class="reference internal" href="waveguicsx.html#waveguicsx.scattering.Scattering"><code class="docutils literal notranslate"><span class="pre">Scattering</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="waveguicsx.html#waveguicsx.scattering.Scattering.set_ingoing_mode"><code class="docutils literal notranslate"><span class="pre">Scattering.set_ingoing_mode()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="waveguicsx.html#waveguicsx.scattering.Scattering.set_internal_excitation"><code class="docutils literal notranslate"><span class="pre">Scattering.set_internal_excitation()</span></code></a></li>
Expand Down
Binary file modified docs/objects.inv
View file
Binary file not shown.
5 changes: 3 additions & 2 deletions docs/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguicsx.waveguide</a></li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguide.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html#module-waveguicsx.scattering">scattering.py</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
Expand Down Expand Up @@ -113,7 +114,7 @@ <h1>Python Module Index</h1>
<td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td>
<td>
<a href="waveguicsx.html#module-waveguicsx"><code class="xref">waveguicsx</code></a></td><td>
<code class="xref">waveguicsx</code></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
Expand Down
3 changes: 2 additions & 1 deletion docs/search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguicsx.waveguide</a></li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html">waveguide.py</a></li>
<li class="toctree-l2"><a class="reference internal" href="waveguicsx.html#module-waveguicsx.scattering">scattering.py</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a><ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 001e2a3

Please sign in to comment.