Skip to content

Commit a78743e

Browse files
zingalezingale
authored
fix some autodoc issues (#316)
1 parent 7351d08 commit a78743e

8 files changed

+152
-16
lines changed

‎docs/source/pyro.advection_fv4.rst‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,6 @@ pyro.advection\_fv4.fluxes module
2525
:undoc-members:
2626
:show-inheritance:
2727

28-
pyro.advection\_fv4.interface module
29-
------------------------------------
30-
31-
.. automodule:: pyro.advection_fv4.interface
32-
:members:
33-
:undoc-members:
34-
:show-inheritance:
35-
3628
pyro.advection\_fv4.simulation module
3729
-------------------------------------
3830

‎docs/source/pyro.compressible.problems.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ pyro.compressible.problems.bubble module
3333
:undoc-members:
3434
:show-inheritance:
3535

36+
pyro.compressible.problems.convection module
37+
--------------------------------------------
38+
39+
.. automodule:: pyro.compressible.problems.convection
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
3644
pyro.compressible.problems.gresho module
3745
----------------------------------------
3846

@@ -41,6 +49,14 @@ pyro.compressible.problems.gresho module
4149
:undoc-members:
4250
:show-inheritance:
4351

52+
pyro.compressible.problems.heating module
53+
-----------------------------------------
54+
55+
.. automodule:: pyro.compressible.problems.heating
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
4460
pyro.compressible.problems.hse module
4561
-------------------------------------
4662

@@ -65,6 +81,14 @@ pyro.compressible.problems.logo module
6581
:undoc-members:
6682
:show-inheritance:
6783

84+
pyro.compressible.problems.plume module
85+
---------------------------------------
86+
87+
.. automodule:: pyro.compressible.problems.plume
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
6892
pyro.compressible.problems.quad module
6993
--------------------------------------
7094

@@ -97,6 +121,14 @@ pyro.compressible.problems.rt2 module
97121
:undoc-members:
98122
:show-inheritance:
99123

124+
pyro.compressible.problems.rt\_multimode module
125+
-----------------------------------------------
126+
127+
.. automodule:: pyro.compressible.problems.rt_multimode
128+
:members:
129+
:undoc-members:
130+
:show-inheritance:
131+
100132
pyro.compressible.problems.sedov module
101133
---------------------------------------
102134

‎docs/source/pyro.compressible.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ pyro.compressible.BC module
2525
:undoc-members:
2626
:show-inheritance:
2727

28+
pyro.compressible.cgf module
29+
----------------------------
30+
31+
.. automodule:: pyro.compressible.cgf
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
2836
pyro.compressible.derives module
2937
--------------------------------
3038

@@ -49,6 +57,14 @@ pyro.compressible.interface module
4957
:undoc-members:
5058
:show-inheritance:
5159

60+
pyro.compressible.prim module
61+
-----------------------------
62+
63+
.. automodule:: pyro.compressible.prim
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
5268
pyro.compressible.riemann module
5369
--------------------------------
5470

‎docs/source/pyro.compressible_fv4.problems.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ pyro.compressible\_fv4.problems.bubble module
3333
:undoc-members:
3434
:show-inheritance:
3535

36+
pyro.compressible\_fv4.problems.convection module
37+
-------------------------------------------------
38+
39+
.. automodule:: pyro.compressible_fv4.problems.convection
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
3644
pyro.compressible\_fv4.problems.gresho module
3745
---------------------------------------------
3846

@@ -41,6 +49,14 @@ pyro.compressible\_fv4.problems.gresho module
4149
:undoc-members:
4250
:show-inheritance:
4351

52+
pyro.compressible\_fv4.problems.heating module
53+
----------------------------------------------
54+
55+
.. automodule:: pyro.compressible_fv4.problems.heating
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
4460
pyro.compressible\_fv4.problems.hse module
4561
------------------------------------------
4662

@@ -65,6 +81,14 @@ pyro.compressible\_fv4.problems.logo module
6581
:undoc-members:
6682
:show-inheritance:
6783

84+
pyro.compressible\_fv4.problems.plume module
85+
--------------------------------------------
86+
87+
.. automodule:: pyro.compressible_fv4.problems.plume
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
6892
pyro.compressible\_fv4.problems.quad module
6993
-------------------------------------------
7094

@@ -97,6 +121,14 @@ pyro.compressible\_fv4.problems.rt2 module
97121
:undoc-members:
98122
:show-inheritance:
99123

124+
pyro.compressible\_fv4.problems.rt\_multimode module
125+
----------------------------------------------------
126+
127+
.. automodule:: pyro.compressible_fv4.problems.rt_multimode
128+
:members:
129+
:undoc-members:
130+
:show-inheritance:
131+
100132
pyro.compressible\_fv4.problems.sedov module
101133
--------------------------------------------
102134

‎docs/source/pyro.compressible_rk.problems.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ pyro.compressible\_rk.problems.bubble module
3333
:undoc-members:
3434
:show-inheritance:
3535

36+
pyro.compressible\_rk.problems.convection module
37+
------------------------------------------------
38+
39+
.. automodule:: pyro.compressible_rk.problems.convection
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
3644
pyro.compressible\_rk.problems.gresho module
3745
--------------------------------------------
3846

@@ -41,6 +49,14 @@ pyro.compressible\_rk.problems.gresho module
4149
:undoc-members:
4250
:show-inheritance:
4351

52+
pyro.compressible\_rk.problems.heating module
53+
---------------------------------------------
54+
55+
.. automodule:: pyro.compressible_rk.problems.heating
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
4460
pyro.compressible\_rk.problems.hse module
4561
-----------------------------------------
4662

@@ -65,6 +81,14 @@ pyro.compressible\_rk.problems.logo module
6581
:undoc-members:
6682
:show-inheritance:
6783

84+
pyro.compressible\_rk.problems.plume module
85+
-------------------------------------------
86+
87+
.. automodule:: pyro.compressible_rk.problems.plume
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
6892
pyro.compressible\_rk.problems.quad module
6993
------------------------------------------
7094

@@ -97,6 +121,14 @@ pyro.compressible\_rk.problems.rt2 module
97121
:undoc-members:
98122
:show-inheritance:
99123

124+
pyro.compressible\_rk.problems.rt\_multimode module
125+
---------------------------------------------------
126+
127+
.. automodule:: pyro.compressible_rk.problems.rt_multimode
128+
:members:
129+
:undoc-members:
130+
:show-inheritance:
131+
100132
pyro.compressible\_rk.problems.sedov module
101133
-------------------------------------------
102134

‎docs/source/pyro.compressible_sdc.problems.rst‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,14 @@ pyro.compressible\_sdc.problems.bubble module
3333
:undoc-members:
3434
:show-inheritance:
3535

36+
pyro.compressible\_sdc.problems.convection module
37+
-------------------------------------------------
38+
39+
.. automodule:: pyro.compressible_sdc.problems.convection
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
3644
pyro.compressible\_sdc.problems.gresho module
3745
---------------------------------------------
3846

@@ -41,6 +49,14 @@ pyro.compressible\_sdc.problems.gresho module
4149
:undoc-members:
4250
:show-inheritance:
4351

52+
pyro.compressible\_sdc.problems.heating module
53+
----------------------------------------------
54+
55+
.. automodule:: pyro.compressible_sdc.problems.heating
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
4460
pyro.compressible\_sdc.problems.hse module
4561
------------------------------------------
4662

@@ -65,6 +81,14 @@ pyro.compressible\_sdc.problems.logo module
6581
:undoc-members:
6682
:show-inheritance:
6783

84+
pyro.compressible\_sdc.problems.plume module
85+
--------------------------------------------
86+
87+
.. automodule:: pyro.compressible_sdc.problems.plume
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
6892
pyro.compressible\_sdc.problems.quad module
6993
-------------------------------------------
7094

@@ -97,6 +121,14 @@ pyro.compressible\_sdc.problems.rt2 module
97121
:undoc-members:
98122
:show-inheritance:
99123

124+
pyro.compressible\_sdc.problems.rt\_multimode module
125+
----------------------------------------------------
126+
127+
.. automodule:: pyro.compressible_sdc.problems.rt_multimode
128+
:members:
129+
:undoc-members:
130+
:show-inheritance:
131+
100132
pyro.compressible\_sdc.problems.sedov module
101133
--------------------------------------------
102134

‎docs/source/pyro.lm_atm.problems.rst‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,3 @@ pyro.lm\_atm.problems.bubble module
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
19-
20-
pyro.lm\_atm.problems.gresho module
21-
-----------------------------------
22-
23-
.. automodule:: pyro.lm_atm.problems.gresho
24-
:members:
25-
:undoc-members:
26-
:show-inheritance:

‎docs/source/pyro.mesh.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,14 @@ pyro.mesh.boundary module
2525
:undoc-members:
2626
:show-inheritance:
2727

28+
pyro.mesh.fourth\_order module
29+
------------------------------
30+
31+
.. automodule:: pyro.mesh.fourth_order
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
2836
pyro.mesh.fv module
2937
-------------------
3038

0 commit comments

Comments
 (0)