diff --git a/docs/api/index.rst b/docs/api/index.rst index 9a77908bd4..70e96612c5 100644 --- 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 index 84b21c2af1..3bfb7d5bf8 100644 --- a/docs/api/mode.rst +++ b/docs/api/mode.rst @@ -1,12 +1 @@ -.. currentmodule:: tidy3d - -Mode Specifications -=================== - -.. autosummary:: - :toctree: _autosummary/ - :template: module.rst - - tidy3d.ModeSpec - tidy3d.ModeSortSpec - tidy3d.ModeInterpSpec \ No newline at end of file +.. include:: /api/mode/index.rst diff --git a/docs/api/mode/deprecated.rst b/docs/api/mode/deprecated.rst new file mode 100644 index 0000000000..13c9a68db1 --- /dev/null +++ b/docs/api/mode/deprecated.rst @@ -0,0 +1,15 @@ +.. currentmodule:: tidy3d + +Deprecated +---------- + +.. deprecated:: + ``tidy3d.plugins.mode.ModeSolver`` is will be deprecated in a future version. Please use :class:`tidy3d.ModeSimulation` instead starting from version 2.10.0. + +.. autosummary:: + :toctree: ../_autosummary/ + :template: module.rst + + tidy3d.plugins.mode.ModeSolver + tidy3d.plugins.mode.ModeSolverData + diff --git a/docs/api/mode/index.rst b/docs/api/mode/index.rst new file mode 100644 index 0000000000..556e81c46d --- /dev/null +++ b/docs/api/mode/index.rst @@ -0,0 +1,16 @@ +Mode |:record_button:| +====================== + +.. toctree:: + :hidden: + + simulation + specification + output_data + deprecated + + +.. include:: /api/mode/simulation.rst +.. include:: /api/mode/specification.rst +.. include:: /api/mode/output_data.rst +.. include:: /api/mode/deprecated.rst diff --git a/docs/api/mode/output_data.rst b/docs/api/mode/output_data.rst new file mode 100644 index 0000000000..38ea54f84f --- /dev/null +++ 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 new file mode 100644 index 0000000000..d737632607 --- /dev/null +++ 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 new file mode 100644 index 0000000000..a3fa6f34af --- /dev/null +++ b/docs/api/mode/specification.rst @@ -0,0 +1,13 @@ +.. currentmodule:: tidy3d + +Mode Specifications +=================== + +.. autosummary:: + :toctree: ../_autosummary/ + :template: module.rst + + tidy3d.ModeSpec + tidy3d.ModeSortSpec + tidy3d.ModeInterpSpec + diff --git a/docs/api/simulation.rst b/docs/api/simulation.rst index 9427064255..44b9cd1954 100644 --- 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