Skip to content

fix some autodoc issues #316

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zingale merged 1 commit into from
Jan 18, 2025
Merged

fix some autodoc issues #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 0 additions & 8 deletions docs/source/pyro.advection_fv4.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------------------------

Expand Down
32 changes: 32 additions & 0 deletions docs/source/pyro.compressible.problems.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------------------------------

Expand All @@ -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
-------------------------------------

Expand All @@ -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
--------------------------------------

Expand Down Expand Up @@ -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
---------------------------------------

Expand Down
16 changes: 16 additions & 0 deletions docs/source/pyro.compressible.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------------

Expand All @@ -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
--------------------------------

Expand Down
32 changes: 32 additions & 0 deletions docs/source/pyro.compressible_fv4.problems.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------------------------------

Expand All @@ -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
------------------------------------------

Expand All @@ -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
-------------------------------------------

Expand Down Expand Up @@ -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
--------------------------------------------

Expand Down
32 changes: 32 additions & 0 deletions docs/source/pyro.compressible_rk.problems.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------------------------

Expand All @@ -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
-----------------------------------------

Expand All @@ -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
------------------------------------------

Expand Down Expand Up @@ -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
-------------------------------------------

Expand Down
32 changes: 32 additions & 0 deletions docs/source/pyro.compressible_sdc.problems.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------------------------------

Expand All @@ -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
------------------------------------------

Expand All @@ -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
-------------------------------------------

Expand Down Expand Up @@ -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
--------------------------------------------

Expand Down
8 changes: 0 additions & 8 deletions docs/source/pyro.lm_atm.problems.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
8 changes: 8 additions & 0 deletions docs/source/pyro.mesh.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------------

Expand Down
Loading