docs: introduce ModeSimulation

daquinteroflex · daquinteroflex · commit 6192392e7ccf · 2025-11-07T16:37:37.000+01:00
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -20,6 +20,7 @@ API |:computer:|
     utilities
     configuration
     mesh/index
+    mode/index
     heat/index
     charge/index
     eme/index
diff --git a/docs/api/mode.rst b/docs/api/mode.rst
@@ -1,10 +1 @@
-.. currentmodule:: tidy3d
-
-Mode Specifications
-===================
-
-.. autosummary::
-   :toctree: _autosummary/
-   :template: module.rst
-
-   tidy3d.ModeSpec
+.. include:: /api/mode/index.rst
diff --git a/docs/api/mode/index.rst b/docs/api/mode/index.rst
@@ -0,0 +1,14 @@
+Mode |:record_button:|
+======================
+
+.. toctree::
+    :hidden:
+
+    simulation
+    specification
+    output_data
+
+
+.. include:: /api/mode/simulation.rst
+.. include:: /api/mode/specification.rst
+.. include:: /api/mode/output_data.rst
diff --git a/docs/api/mode/output_data.rst b/docs/api/mode/output_data.rst
@@ -0,0 +1,33 @@
+.. currentmodule:: tidy3d
+
+Output Data
+-----------
+
+Simulation Data
+^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.ModeSimulationData
+
+
+Monitor Data
+^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.ModeSolverData
+
+
+Datasets
+^^^^^^^^
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.ModeSolverDataset
diff --git a/docs/api/mode/simulation.rst b/docs/api/mode/simulation.rst
@@ -0,0 +1,10 @@
+.. currentmodule:: tidy3d
+
+Mode Simulation
+===============
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.ModeSimulation
diff --git a/docs/api/mode/specification.rst b/docs/api/mode/specification.rst
@@ -0,0 +1,11 @@
+.. currentmodule:: tidy3d
+
+Mode Specifications
+===================
+
+.. autosummary::
+   :toctree: ../_autosummary/
+   :template: module.rst
+
+   tidy3d.ModeSpec
+   tidy3d.ModeSortSpec
diff --git a/docs/api/simulation.rst b/docs/api/simulation.rst
@@ -40,7 +40,7 @@ Other Simulation Types
    :toctree: _autosummary/
    :template: module.rst
 
-   tidy3d.plugins.mode.ModeSolver
+   tidy3d.ModeSimulation
    tidy3d.EMESimulation
    tidy3d.HeatSimulation
    tidy3d.HeatChargeSimulation
