From b36b144ad09de39b0ae9e24f91b119a2ff4c9473 Mon Sep 17 00:00:00 2001 From: Michael Zingale Date: Sat, 18 Jan 2025 13:20:22 -0500 Subject: [PATCH] fix some autodoc issues --- docs/source/pyro.advection_fv4.rst | 8 ----- docs/source/pyro.compressible.problems.rst | 32 +++++++++++++++++++ docs/source/pyro.compressible.rst | 16 ++++++++++ .../source/pyro.compressible_fv4.problems.rst | 32 +++++++++++++++++++ docs/source/pyro.compressible_rk.problems.rst | 32 +++++++++++++++++++ .../source/pyro.compressible_sdc.problems.rst | 32 +++++++++++++++++++ docs/source/pyro.lm_atm.problems.rst | 8 ----- docs/source/pyro.mesh.rst | 8 +++++ 8 files changed, 152 insertions(+), 16 deletions(-) diff --git a/docs/source/pyro.advection_fv4.rst b/docs/source/pyro.advection_fv4.rst index 00036cb53..25355f87d 100644 --- a/docs/source/pyro.advection_fv4.rst +++ b/docs/source/pyro.advection_fv4.rst @@ -25,14 +25,6 @@ pyro.advection\_fv4.fluxes module :undoc-members: :show-inheritance: -pyro.advection\_fv4.interface module ------------------------------------- - -.. automodule:: pyro.advection_fv4.interface - :members: - :undoc-members: - :show-inheritance: - pyro.advection\_fv4.simulation module ------------------------------------- diff --git a/docs/source/pyro.compressible.problems.rst b/docs/source/pyro.compressible.problems.rst index 61f611e85..84e48169a 100644 --- a/docs/source/pyro.compressible.problems.rst +++ b/docs/source/pyro.compressible.problems.rst @@ -33,6 +33,14 @@ pyro.compressible.problems.bubble module :undoc-members: :show-inheritance: +pyro.compressible.problems.convection module +-------------------------------------------- + +.. automodule:: pyro.compressible.problems.convection + :members: + :undoc-members: + :show-inheritance: + pyro.compressible.problems.gresho module ---------------------------------------- @@ -41,6 +49,14 @@ pyro.compressible.problems.gresho module :undoc-members: :show-inheritance: +pyro.compressible.problems.heating module +----------------------------------------- + +.. automodule:: pyro.compressible.problems.heating + :members: + :undoc-members: + :show-inheritance: + pyro.compressible.problems.hse module ------------------------------------- @@ -65,6 +81,14 @@ pyro.compressible.problems.logo module :undoc-members: :show-inheritance: +pyro.compressible.problems.plume module +--------------------------------------- + +.. automodule:: pyro.compressible.problems.plume + :members: + :undoc-members: + :show-inheritance: + pyro.compressible.problems.quad module -------------------------------------- @@ -97,6 +121,14 @@ pyro.compressible.problems.rt2 module :undoc-members: :show-inheritance: +pyro.compressible.problems.rt\_multimode module +----------------------------------------------- + +.. automodule:: pyro.compressible.problems.rt_multimode + :members: + :undoc-members: + :show-inheritance: + pyro.compressible.problems.sedov module --------------------------------------- diff --git a/docs/source/pyro.compressible.rst b/docs/source/pyro.compressible.rst index 8b74c572b..76224e4c0 100644 --- a/docs/source/pyro.compressible.rst +++ b/docs/source/pyro.compressible.rst @@ -25,6 +25,14 @@ pyro.compressible.BC module :undoc-members: :show-inheritance: +pyro.compressible.cgf module +---------------------------- + +.. automodule:: pyro.compressible.cgf + :members: + :undoc-members: + :show-inheritance: + pyro.compressible.derives module -------------------------------- @@ -49,6 +57,14 @@ pyro.compressible.interface module :undoc-members: :show-inheritance: +pyro.compressible.prim module +----------------------------- + +.. automodule:: pyro.compressible.prim + :members: + :undoc-members: + :show-inheritance: + pyro.compressible.riemann module -------------------------------- diff --git a/docs/source/pyro.compressible_fv4.problems.rst b/docs/source/pyro.compressible_fv4.problems.rst index 4f7f104c7..a6bda1d79 100644 --- a/docs/source/pyro.compressible_fv4.problems.rst +++ b/docs/source/pyro.compressible_fv4.problems.rst @@ -33,6 +33,14 @@ pyro.compressible\_fv4.problems.bubble module :undoc-members: :show-inheritance: +pyro.compressible\_fv4.problems.convection module +------------------------------------------------- + +.. automodule:: pyro.compressible_fv4.problems.convection + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_fv4.problems.gresho module --------------------------------------------- @@ -41,6 +49,14 @@ pyro.compressible\_fv4.problems.gresho module :undoc-members: :show-inheritance: +pyro.compressible\_fv4.problems.heating module +---------------------------------------------- + +.. automodule:: pyro.compressible_fv4.problems.heating + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_fv4.problems.hse module ------------------------------------------ @@ -65,6 +81,14 @@ pyro.compressible\_fv4.problems.logo module :undoc-members: :show-inheritance: +pyro.compressible\_fv4.problems.plume module +-------------------------------------------- + +.. automodule:: pyro.compressible_fv4.problems.plume + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_fv4.problems.quad module ------------------------------------------- @@ -97,6 +121,14 @@ pyro.compressible\_fv4.problems.rt2 module :undoc-members: :show-inheritance: +pyro.compressible\_fv4.problems.rt\_multimode module +---------------------------------------------------- + +.. automodule:: pyro.compressible_fv4.problems.rt_multimode + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_fv4.problems.sedov module -------------------------------------------- diff --git a/docs/source/pyro.compressible_rk.problems.rst b/docs/source/pyro.compressible_rk.problems.rst index 0f402461a..261598983 100644 --- a/docs/source/pyro.compressible_rk.problems.rst +++ b/docs/source/pyro.compressible_rk.problems.rst @@ -33,6 +33,14 @@ pyro.compressible\_rk.problems.bubble module :undoc-members: :show-inheritance: +pyro.compressible\_rk.problems.convection module +------------------------------------------------ + +.. automodule:: pyro.compressible_rk.problems.convection + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_rk.problems.gresho module -------------------------------------------- @@ -41,6 +49,14 @@ pyro.compressible\_rk.problems.gresho module :undoc-members: :show-inheritance: +pyro.compressible\_rk.problems.heating module +--------------------------------------------- + +.. automodule:: pyro.compressible_rk.problems.heating + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_rk.problems.hse module ----------------------------------------- @@ -65,6 +81,14 @@ pyro.compressible\_rk.problems.logo module :undoc-members: :show-inheritance: +pyro.compressible\_rk.problems.plume module +------------------------------------------- + +.. automodule:: pyro.compressible_rk.problems.plume + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_rk.problems.quad module ------------------------------------------ @@ -97,6 +121,14 @@ pyro.compressible\_rk.problems.rt2 module :undoc-members: :show-inheritance: +pyro.compressible\_rk.problems.rt\_multimode module +--------------------------------------------------- + +.. automodule:: pyro.compressible_rk.problems.rt_multimode + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_rk.problems.sedov module ------------------------------------------- diff --git a/docs/source/pyro.compressible_sdc.problems.rst b/docs/source/pyro.compressible_sdc.problems.rst index 678f4c4e5..7c3409810 100644 --- a/docs/source/pyro.compressible_sdc.problems.rst +++ b/docs/source/pyro.compressible_sdc.problems.rst @@ -33,6 +33,14 @@ pyro.compressible\_sdc.problems.bubble module :undoc-members: :show-inheritance: +pyro.compressible\_sdc.problems.convection module +------------------------------------------------- + +.. automodule:: pyro.compressible_sdc.problems.convection + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_sdc.problems.gresho module --------------------------------------------- @@ -41,6 +49,14 @@ pyro.compressible\_sdc.problems.gresho module :undoc-members: :show-inheritance: +pyro.compressible\_sdc.problems.heating module +---------------------------------------------- + +.. automodule:: pyro.compressible_sdc.problems.heating + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_sdc.problems.hse module ------------------------------------------ @@ -65,6 +81,14 @@ pyro.compressible\_sdc.problems.logo module :undoc-members: :show-inheritance: +pyro.compressible\_sdc.problems.plume module +-------------------------------------------- + +.. automodule:: pyro.compressible_sdc.problems.plume + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_sdc.problems.quad module ------------------------------------------- @@ -97,6 +121,14 @@ pyro.compressible\_sdc.problems.rt2 module :undoc-members: :show-inheritance: +pyro.compressible\_sdc.problems.rt\_multimode module +---------------------------------------------------- + +.. automodule:: pyro.compressible_sdc.problems.rt_multimode + :members: + :undoc-members: + :show-inheritance: + pyro.compressible\_sdc.problems.sedov module -------------------------------------------- diff --git a/docs/source/pyro.lm_atm.problems.rst b/docs/source/pyro.lm_atm.problems.rst index 33a87723e..65599aa5a 100644 --- a/docs/source/pyro.lm_atm.problems.rst +++ b/docs/source/pyro.lm_atm.problems.rst @@ -16,11 +16,3 @@ pyro.lm\_atm.problems.bubble module :members: :undoc-members: :show-inheritance: - -pyro.lm\_atm.problems.gresho module ------------------------------------ - -.. automodule:: pyro.lm_atm.problems.gresho - :members: - :undoc-members: - :show-inheritance: diff --git a/docs/source/pyro.mesh.rst b/docs/source/pyro.mesh.rst index 8caafa979..9c439c18f 100644 --- a/docs/source/pyro.mesh.rst +++ b/docs/source/pyro.mesh.rst @@ -25,6 +25,14 @@ pyro.mesh.boundary module :undoc-members: :show-inheritance: +pyro.mesh.fourth\_order module +------------------------------ + +.. automodule:: pyro.mesh.fourth_order + :members: + :undoc-members: + :show-inheritance: + pyro.mesh.fv module -------------------