Skip to content

Commit f8ed026

Browse files
docs: Created utils toctree
1 parent 570437a commit f8ed026

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

docs/api/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ API |:computer:|
2323
output_data
2424
scene
2525
logging
26+
utilities
2627
submit_simulations
2728
mesh/index
2829
heat/index
@@ -37,6 +38,7 @@ API |:computer:|
3738
viz
3839

3940
.. include:: /api/simulation.rst
41+
.. include:: /api/utilities.rst
4042
.. include:: /api/boundary_conditions.rst
4143
.. include:: /api/geometry.rst
4244
.. include:: /api/mediums.rst
@@ -62,4 +64,4 @@ API |:computer:|
6264
.. include:: /api/constants.rst
6365
.. include:: /api/abstract_base.rst
6466
.. include:: /api/abstract_models.rst
65-
.. include:: /api/viz.rst
67+
.. include:: /api/viz.rst

docs/api/simulation.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,3 @@ Simulation
88
:template: module.rst
99

1010
tidy3d.Simulation
11-
tidy3d.RunTimeSpec
12-
tidy3d.FreqRange

docs/api/utils.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
.. currentmodule:: tidy3d
2+
3+
Utilities
4+
=========
5+
6+
.. autosummary::
7+
:toctree: _autosummary/
8+
:template: module.rst
9+
10+
tidy3d.RunTimeSpec
11+
tidy3d.FreqRange
12+
tidy3d.FreqUtils

0 commit comments

Comments
 (0)