Skip to content

Commit a215408

Browse files
harpoleaharpolea
committed
Add backslashes back to docs that sphinx-apidoc removed
1 parent 936cd80 commit a215408

26 files changed

Lines changed: 164 additions & 216 deletions

‎docs/source/advection.problems.rst‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
advection.problems package
2-
==========================
1+
advection\.problems package
2+
===========================
33

44
.. automodule:: advection.problems
55
:members:
@@ -9,28 +9,26 @@ advection.problems package
99
Submodules
1010
----------
1111

12-
advection.problems.smooth module
13-
--------------------------------
12+
advection\.problems\.smooth module
13+
----------------------------------
1414

1515
.. automodule:: advection.problems.smooth
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
1919

20-
advection.problems.test module
21-
------------------------------
20+
advection\.problems\.test module
21+
--------------------------------
2222

2323
.. automodule:: advection.problems.test
2424
:members:
2525
:undoc-members:
2626
:show-inheritance:
2727

28-
advection.problems.tophat module
29-
--------------------------------
28+
advection\.problems\.tophat module
29+
----------------------------------
3030

3131
.. automodule:: advection.problems.tophat
3232
:members:
3333
:undoc-members:
3434
:show-inheritance:
35-
36-

‎docs/source/advection.rst‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,18 @@ Subpackages
1616
Submodules
1717
----------
1818

19-
advection.advective\_fluxes module
20-
----------------------------------
19+
advection\.advective\_fluxes module
20+
-----------------------------------
2121

2222
.. automodule:: advection.advective_fluxes
2323
:members:
2424
:undoc-members:
2525
:show-inheritance:
2626

27-
advection.simulation module
28-
---------------------------
27+
advection\.simulation module
28+
----------------------------
2929

3030
.. automodule:: advection.simulation
3131
:members:
3232
:undoc-members:
3333
:show-inheritance:
34-
35-

‎docs/source/advection_fv4.problems.rst‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
advection\_fv4.problems package
2-
===============================
1+
advection\_fv4\.problems package
2+
================================
33

44
.. automodule:: advection_fv4.problems
55
:members:
@@ -9,12 +9,10 @@ advection\_fv4.problems package
99
Submodules
1010
----------
1111

12-
advection\_fv4.problems.smooth module
13-
-------------------------------------
12+
advection\_fv4\.problems\.smooth module
13+
---------------------------------------
1414

1515
.. automodule:: advection_fv4.problems.smooth
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
19-
20-

‎docs/source/advection_fv4.rst‎

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

19-
advection\_fv4.fluxes module
20-
----------------------------
19+
advection\_fv4\.fluxes module
20+
-----------------------------
2121

2222
.. automodule:: advection_fv4.fluxes
2323
:members:
2424
:undoc-members:
2525
:show-inheritance:
2626

27-
advection\_fv4.interface module
28-
-------------------------------
27+
advection\_fv4\.interface module
28+
--------------------------------
2929

3030
.. automodule:: advection_fv4.interface
3131
:members:
3232
:undoc-members:
3333
:show-inheritance:
3434

35-
advection\_fv4.simulation module
36-
--------------------------------
35+
advection\_fv4\.simulation module
36+
---------------------------------
3737

3838
.. automodule:: advection_fv4.simulation
3939
:members:
4040
:undoc-members:
4141
:show-inheritance:
42-
43-

‎docs/source/advection_nonuniform.problems.rst‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
advection\_nonuniform.problems package
2-
======================================
1+
advection\_nonuniform\.problems package
2+
=======================================
33

44
.. automodule:: advection_nonuniform.problems
55
:members:
@@ -9,36 +9,34 @@ advection\_nonuniform.problems package
99
Submodules
1010
----------
1111

12-
advection\_nonuniform.problems.slotted module
13-
---------------------------------------------
12+
advection\_nonuniform\.problems\.slotted module
13+
-----------------------------------------------
1414

1515
.. automodule:: advection_nonuniform.problems.slotted
1616
:members:
1717
:undoc-members:
1818
:show-inheritance:
1919

20-
advection\_nonuniform.problems.smooth module
21-
--------------------------------------------
20+
advection\_nonuniform\.problems\.smooth module
21+
----------------------------------------------
2222

2323
.. automodule:: advection_nonuniform.problems.smooth
2424
:members:
2525
:undoc-members:
2626
:show-inheritance:
2727

28-
advection\_nonuniform.problems.test module
29-
------------------------------------------
28+
advection\_nonuniform\.problems\.test module
29+
--------------------------------------------
3030

3131
.. automodule:: advection_nonuniform.problems.test
3232
:members:
3333
:undoc-members:
3434
:show-inheritance:
3535

36-
advection\_nonuniform.problems.tophat module
37-
--------------------------------------------
36+
advection\_nonuniform\.problems\.tophat module
37+
----------------------------------------------
3838

3939
.. automodule:: advection_nonuniform.problems.tophat
4040
:members:
4141
:undoc-members:
4242
:show-inheritance:
43-
44-

‎docs/source/advection_nonuniform.rst‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,18 @@ Subpackages
1616
Submodules
1717
----------
1818

19-
advection\_nonuniform.advective\_fluxes module
20-
----------------------------------------------
19+
advection\_nonuniform\.advective\_fluxes module
20+
-----------------------------------------------
2121

2222
.. automodule:: advection_nonuniform.advective_fluxes
2323
:members:
2424
:undoc-members:
2525
:show-inheritance:
2626

27-
advection\_nonuniform.simulation module
28-
---------------------------------------
27+
advection\_nonuniform\.simulation module
28+
----------------------------------------
2929

3030
.. automodule:: advection_nonuniform.simulation
3131
:members:
3232
:undoc-members:
3333
:show-inheritance:
34-
35-

‎docs/source/advection_rk.rst‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,23 @@ Subpackages
1111

1212
.. toctree::
1313

14-
advection_rk.problems
14+
advection_rk\.problems
1515

1616
Submodules
1717
----------
1818

19-
advection\_rk.fluxes module
20-
---------------------------
19+
advection\_rk\.fluxes module
20+
----------------------------
2121

2222
.. automodule:: advection_rk.fluxes
2323
:members:
2424
:undoc-members:
2525
:show-inheritance:
2626

27-
advection\_rk.simulation module
28-
-------------------------------
27+
advection\_rk\.simulation module
28+
--------------------------------
2929

3030
.. automodule:: advection_rk.simulation
3131
:members:
3232
:undoc-members:
3333
:show-inheritance:
34-
35-

‎docs/source/advection_weno.rst‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,20 +16,18 @@ Subpackages
1616
Submodules
1717
----------
1818

19-
advection\_weno.fluxes module
20-
-----------------------------
19+
advection\_weno\.fluxes module
20+
------------------------------
2121

2222
.. automodule:: advection_weno.fluxes
2323
:members:
2424
:undoc-members:
2525
:show-inheritance:
2626

27-
advection\_weno.simulation module
28-
---------------------------------
27+
advection\_weno\.simulation module
28+
----------------------------------
2929

3030
.. automodule:: advection_weno.simulation
3131
:members:
3232
:undoc-members:
3333
:show-inheritance:
34-
35-

0 commit comments

Comments
 (0)