jan/meanas
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Publish docs for local build

Browse source
This commit is contained in:
Forgejo Actions 2026-04-19 00:50:40 -07:00
commit e7cd1f4d50
5 changed files with 161 additions and 146 deletions
Download patch file Download diff file Expand all files Collapse all files

30
index.html
View file

@ -284,10 +284,10 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#recommended-starting-points" class="md-nav__link">
<a href="#examples-and-api-map" class="md-nav__link">
<span class="md-ellipsis">
Recommended starting points
Examples and API Map
</span>
</a>
@ -594,10 +594,10 @@
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#recommended-starting-points" class="md-nav__link">
<a href="#examples-and-api-map" class="md-nav__link">
<span class="md-ellipsis">
Recommended starting points
Examples and API Map
</span>
</a>
@ -643,16 +643,20 @@ It combines:</p>
<p>This documentation is built directly from the package docstrings. The API pages
are the source of truth for the mathematical derivations and calling
conventions.</p>
<h2 id="recommended-starting-points">Recommended starting points<a class="headerlink" href="#recommended-starting-points" title="Permanent link">&para;</a></h2>
<h2 id="examples-and-api-map">Examples and API Map<a class="headerlink" href="#examples-and-api-map" title="Permanent link">&para;</a></h2>
<p>For most users, the tracked examples under <code>examples/</code> are the right entry
point. They show the intended combinations of tools for solving complete
problems.</p>
<p>The API pages are better read as a toolbox map and derivation reference:</p>
<ul>
<li>Use the <a href="api/fdtd/">FDTD API</a> when you need time-domain stepping, CPML, or
phasor extraction.</li>
<li>Use the <a href="api/fdfd/">FDFD API</a> when you need driven frequency-domain solves
or operator algebra.</li>
<li>Use the <a href="api/waveguides/">Waveguide API</a> for mode solving, port sources, and
overlap windows.</li>
<li>Use the <a href="api/fdmath/">fdmath API</a> when you need the lower-level finite-difference
operators or the derivation background shared across the package.</li>
<li>Use the <a href="api/fdtd/">FDTD API</a> for time-domain stepping, CPML, and phasor
extraction.</li>
<li>Use the <a href="api/fdfd/">FDFD API</a> for driven frequency-domain solves and sparse
operator algebra.</li>
<li>Use the <a href="api/waveguides/">Waveguide API</a> for mode solving, port sources,
and overlap windows.</li>
<li>Use the <a href="api/fdmath/">fdmath API</a> for the lower-level finite-difference
operators and the shared discrete derivations underneath both solvers.</li>
</ul>
<h2 id="build-outputs">Build outputs<a class="headerlink" href="#build-outputs" title="Permanent link">&para;</a></h2>
<p>The docs build generates two HTML views from the same source:</p>