Skip to content

Commit 9de6e24

Browse files
zingalezingale
committed
docs updates
fix IPython highlighting problem
1 parent 51ac378 commit 9de6e24

10 files changed

Lines changed: 53 additions & 43 deletions

‎docs/source/advection_fv4.rst‎

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

27-
advection\_fv4\.setup module
28-
----------------------------
29-
30-
.. automodule:: advection_fv4.setup
31-
:members:
32-
:undoc-members:
33-
:show-inheritance:
34-
3527
advection\_fv4\.simulation module
3628
---------------------------------
3729

‎docs/source/compressible.problems.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,14 @@ compressible\.problems\.kh module
4949
:undoc-members:
5050
:show-inheritance:
5151

52+
compressible\.problems\.logo module
53+
-----------------------------------
54+
55+
.. automodule:: compressible.problems.logo
56+
:members:
57+
:undoc-members:
58+
:show-inheritance:
59+
5260
compressible\.problems\.quad module
5361
-----------------------------------
5462

@@ -57,6 +65,14 @@ compressible\.problems\.quad module
5765
:undoc-members:
5866
:show-inheritance:
5967

68+
compressible\.problems\.ramp module
69+
-----------------------------------
70+
71+
.. automodule:: compressible.problems.ramp
72+
:members:
73+
:undoc-members:
74+
:show-inheritance:
75+
6076
compressible\.problems\.rt module
6177
---------------------------------
6278

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

84+
compressible\.problems\.rt2 module
85+
----------------------------------
86+
87+
.. automodule:: compressible.problems.rt2
88+
:members:
89+
:undoc-members:
90+
:show-inheritance:
91+
6892
compressible\.problems\.sedov module
6993
------------------------------------
7094

‎docs/source/compressible.rst‎

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

43-
compressible\.setup module
44-
--------------------------
45-
46-
.. automodule:: compressible.setup
47-
:members:
48-
:undoc-members:
49-
:show-inheritance:
50-
5143
compressible\.simulation module
5244
-------------------------------
5345

‎docs/source/conf.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@
3939
'sphinx.ext.autosummary',
4040
'nbsphinx',
4141
'numpydoc',
42+
'IPython.sphinxext.ipython_console_highlighting',
4243
'sphinx.ext.githubpages']
4344

4445
# Add any paths that contain templates here, relative to this directory.

‎docs/source/incompressible.rst‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,6 @@ Subpackages
1616
Submodules
1717
----------
1818

19-
incompressible\.setup module
20-
----------------------------
21-
22-
.. automodule:: incompressible.setup
23-
:members:
24-
:undoc-members:
25-
:show-inheritance:
26-
2719
incompressible\.simulation module
2820
---------------------------------
2921

‎docs/source/lm_atm.rst‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,6 @@ Subpackages
1616
Submodules
1717
----------
1818

19-
lm\_atm\.setup module
20-
---------------------
21-
22-
.. automodule:: lm_atm.setup
23-
:members:
24-
:undoc-members:
25-
:show-inheritance:
26-
2719
lm\_atm\.simulation module
2820
--------------------------
2921

‎docs/source/modules.rst‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ pyro2
1414
compressible_react
1515
compressible_rk
1616
compressible_sdc
17+
convergence
1718
diffusion
1819
examples
1920
incompressible
@@ -22,7 +23,9 @@ pyro2
2223
multigrid
2324
particles
2425
plot
26+
plotvar
2527
pyro
28+
setup
2629
simulation_null
2730
swe
2831
test

‎docs/source/particles.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,5 @@ particles\.particles module
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
19+
20+

‎docs/source/swe.problems.rst‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
swe\.problems package
2-
==============================
2+
=====================
33

44
.. automodule:: swe.problems
55
:members:
@@ -10,49 +10,59 @@ Submodules
1010
----------
1111

1212
swe\.problems\.acoustic\_pulse module
13-
----------------------------------------------
13+
-------------------------------------
1414

1515
.. automodule:: swe.problems.acoustic_pulse
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
1919

2020
swe\.problems\.advect module
21-
-------------------------------------
21+
----------------------------
2222

2323
.. automodule:: swe.problems.advect
2424
:members:
2525
:undoc-members:
2626
:show-inheritance:
2727

2828
swe\.problems\.dam module
29-
----------------------------------
29+
-------------------------
3030

3131
.. automodule:: swe.problems.dam
3232
:members:
3333
:undoc-members:
3434
:show-inheritance:
3535

3636
swe\.problems\.kh module
37-
---------------------------------
37+
------------------------
3838

3939
.. automodule:: swe.problems.kh
4040
:members:
4141
:undoc-members:
4242
:show-inheritance:
4343

44+
swe\.problems\.logo module
45+
--------------------------
46+
47+
.. automodule:: swe.problems.logo
48+
:members:
49+
:undoc-members:
50+
:show-inheritance:
51+
4452
swe\.problems\.quad module
45-
-----------------------------------
53+
--------------------------
4654

4755
.. automodule:: swe.problems.quad
4856
:members:
4957
:undoc-members:
5058
:show-inheritance:
5159

5260
swe\.problems\.test module
53-
-----------------------------------
61+
--------------------------
5462

5563
.. automodule:: swe.problems.test
5664
:members:
5765
:undoc-members:
5866
:show-inheritance:
67+
68+

‎docs/source/swe.rst‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
swe package
2-
====================
2+
===========
33

44
.. automodule:: swe
55
:members:
@@ -17,25 +17,27 @@ Submodules
1717
----------
1818

1919
swe\.derives module
20-
----------------------------
20+
-------------------
2121

2222
.. automodule:: swe.derives
2323
:members:
2424
:undoc-members:
2525
:show-inheritance:
2626

2727
swe\.simulation module
28-
-------------------------------
28+
----------------------
2929

3030
.. automodule:: swe.simulation
3131
:members:
3232
:undoc-members:
3333
:show-inheritance:
3434

3535
swe\.unsplit\_fluxes module
36-
------------------------------------
36+
---------------------------
3737

3838
.. automodule:: swe.unsplit_fluxes
3939
:members:
4040
:undoc-members:
4141
:show-inheritance:
42+
43+

0 commit comments

Comments
 (0)