Skip to content

Commit 8e93165

Browse files
yut23yut23
authored
Update documentation tooling (#129)
sphinx-apidoc should be run with `-l` to follow symlinks
1 parent 9a8ca26 commit 8e93165

9 files changed

Lines changed: 445 additions & 26 deletions

‎docs/notes.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
To build the webpages:
1+
To build the webpages (run from docs/):
22

33
make html
44

55

6-
To automatically generate the API docs:
6+
To automatically generate the API docs (run from repository root):
77

8-
sphinx-apidoc -f -M -o docs/source/ . lm_combustion radhydro
8+
sphinx-apidoc -l -f -M -o docs/source/ pyro/
99

10-
(-M puts the module before submodule in the API pages; the directories after . are excludes))
10+
(-M puts the module before submodule in the API pages; any files/directories after pyro/ are excludes)
1111

1212

1313
To support notebooks:

‎docs/source/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
#
9292
# This is also used if you do content translation via gettext catalogs.
9393
# Usually you set "language" from the command line for these cases.
94-
language = None
94+
language = 'en'
9595

9696
# List of patterns, relative to source directory, that match files and
9797
# directories to ignore when looking for source files.

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
pyro.advection\_rk.problems package
2+
===================================
3+
4+
.. automodule:: pyro.advection_rk.problems
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
pyro.advection\_rk.problems.smooth module
13+
-----------------------------------------
14+
15+
.. automodule:: pyro.advection_rk.problems.smooth
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
pyro.advection\_rk.problems.test module
21+
---------------------------------------
22+
23+
.. automodule:: pyro.advection_rk.problems.test
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
pyro.advection\_rk.problems.tophat module
29+
-----------------------------------------
30+
31+
.. automodule:: pyro.advection_rk.problems.tophat
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
pyro.advection\_weno.problems package
2+
=====================================
3+
4+
.. automodule:: pyro.advection_weno.problems
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
pyro.advection\_weno.problems.smooth module
13+
-------------------------------------------
14+
15+
.. automodule:: pyro.advection_weno.problems.smooth
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
pyro.advection\_weno.problems.test module
21+
-----------------------------------------
22+
23+
.. automodule:: pyro.advection_weno.problems.test
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
pyro.advection\_weno.problems.tophat module
29+
-------------------------------------------
30+
31+
.. automodule:: pyro.advection_weno.problems.tophat
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎docs/source/pyro.compressible.rst‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,6 @@ pyro.compressible.eos module
4141
:undoc-members:
4242
:show-inheritance:
4343

44-
pyro.compressible.flycheck\_eos module
45-
--------------------------------------
46-
47-
.. automodule:: pyro.compressible.flycheck_eos
48-
:members:
49-
:undoc-members:
50-
:show-inheritance:
51-
5244
pyro.compressible.interface module
5345
----------------------------------
5446

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

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
pyro.compressible\_fv4.problems package
2+
=======================================
3+
4+
.. automodule:: pyro.compressible_fv4.problems
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
pyro.compressible\_fv4.problems.acoustic\_pulse module
13+
------------------------------------------------------
14+
15+
.. automodule:: pyro.compressible_fv4.problems.acoustic_pulse
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
pyro.compressible\_fv4.problems.advect module
21+
---------------------------------------------
22+
23+
.. automodule:: pyro.compressible_fv4.problems.advect
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
pyro.compressible\_fv4.problems.bubble module
29+
---------------------------------------------
30+
31+
.. automodule:: pyro.compressible_fv4.problems.bubble
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
pyro.compressible\_fv4.problems.gresho module
37+
---------------------------------------------
38+
39+
.. automodule:: pyro.compressible_fv4.problems.gresho
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
pyro.compressible\_fv4.problems.hse module
45+
------------------------------------------
46+
47+
.. automodule:: pyro.compressible_fv4.problems.hse
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
pyro.compressible\_fv4.problems.kh module
53+
-----------------------------------------
54+
55+
.. automodule:: pyro.compressible_fv4.problems.kh
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
pyro.compressible\_fv4.problems.logo module
61+
-------------------------------------------
62+
63+
.. automodule:: pyro.compressible_fv4.problems.logo
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
pyro.compressible\_fv4.problems.quad module
69+
-------------------------------------------
70+
71+
.. automodule:: pyro.compressible_fv4.problems.quad
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
pyro.compressible\_fv4.problems.ramp module
77+
-------------------------------------------
78+
79+
.. automodule:: pyro.compressible_fv4.problems.ramp
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
pyro.compressible\_fv4.problems.rt module
85+
-----------------------------------------
86+
87+
.. automodule:: pyro.compressible_fv4.problems.rt
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
pyro.compressible\_fv4.problems.rt2 module
93+
------------------------------------------
94+
95+
.. automodule:: pyro.compressible_fv4.problems.rt2
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
pyro.compressible\_fv4.problems.sedov module
101+
--------------------------------------------
102+
103+
.. automodule:: pyro.compressible_fv4.problems.sedov
104+
:members:
105+
:undoc-members:
106+
:show-inheritance:
107+
108+
pyro.compressible\_fv4.problems.sod module
109+
------------------------------------------
110+
111+
.. automodule:: pyro.compressible_fv4.problems.sod
112+
:members:
113+
:undoc-members:
114+
:show-inheritance:
115+
116+
pyro.compressible\_fv4.problems.test module
117+
-------------------------------------------
118+
119+
.. automodule:: pyro.compressible_fv4.problems.test
120+
:members:
121+
:undoc-members:
122+
:show-inheritance:

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

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
pyro.compressible\_rk.problems package
2+
======================================
3+
4+
.. automodule:: pyro.compressible_rk.problems
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Submodules
10+
----------
11+
12+
pyro.compressible\_rk.problems.acoustic\_pulse module
13+
-----------------------------------------------------
14+
15+
.. automodule:: pyro.compressible_rk.problems.acoustic_pulse
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
pyro.compressible\_rk.problems.advect module
21+
--------------------------------------------
22+
23+
.. automodule:: pyro.compressible_rk.problems.advect
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
27+
28+
pyro.compressible\_rk.problems.bubble module
29+
--------------------------------------------
30+
31+
.. automodule:: pyro.compressible_rk.problems.bubble
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
35+
36+
pyro.compressible\_rk.problems.gresho module
37+
--------------------------------------------
38+
39+
.. automodule:: pyro.compressible_rk.problems.gresho
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:
43+
44+
pyro.compressible\_rk.problems.hse module
45+
-----------------------------------------
46+
47+
.. automodule:: pyro.compressible_rk.problems.hse
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
52+
pyro.compressible\_rk.problems.kh module
53+
----------------------------------------
54+
55+
.. automodule:: pyro.compressible_rk.problems.kh
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
60+
pyro.compressible\_rk.problems.logo module
61+
------------------------------------------
62+
63+
.. automodule:: pyro.compressible_rk.problems.logo
64+
:members:
65+
:undoc-members:
66+
:show-inheritance:
67+
68+
pyro.compressible\_rk.problems.quad module
69+
------------------------------------------
70+
71+
.. automodule:: pyro.compressible_rk.problems.quad
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
76+
pyro.compressible\_rk.problems.ramp module
77+
------------------------------------------
78+
79+
.. automodule:: pyro.compressible_rk.problems.ramp
80+
:members:
81+
:undoc-members:
82+
:show-inheritance:
83+
84+
pyro.compressible\_rk.problems.rt module
85+
----------------------------------------
86+
87+
.. automodule:: pyro.compressible_rk.problems.rt
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
92+
pyro.compressible\_rk.problems.rt2 module
93+
-----------------------------------------
94+
95+
.. automodule:: pyro.compressible_rk.problems.rt2
96+
:members:
97+
:undoc-members:
98+
:show-inheritance:
99+
100+
pyro.compressible\_rk.problems.sedov module
101+
-------------------------------------------
102+
103+
.. automodule:: pyro.compressible_rk.problems.sedov
104+
:members:
105+
:undoc-members:
106+
:show-inheritance:
107+
108+
pyro.compressible\_rk.problems.sod module
109+
-----------------------------------------
110+
111+
.. automodule:: pyro.compressible_rk.problems.sod
112+
:members:
113+
:undoc-members:
114+
:show-inheritance:
115+
116+
pyro.compressible\_rk.problems.test module
117+
------------------------------------------
118+
119+
.. automodule:: pyro.compressible_rk.problems.test
120+
:members:
121+
:undoc-members:
122+
:show-inheritance:

0 commit comments

Comments
 (0)