Skip to content

Commit e11269d

Browse files
pancettapancetta
committed
fix doc and coverage problems?
1 parent 71a9011 commit e11269d

12 files changed

+869
-2
lines changed

‎.coveragerc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[run]
22
omit =
3-
pySDC/tests/*
3+
*/pySDC/tests/*
44
*/data/*
5-
pySDC/playgrounds/*
5+
*/pySDC/playgrounds/*
66

77
[report]
88
skip_empty = True

‎docs/source/pySDC/core.rst‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
core package
2+
============
3+
4+
Submodules
5+
----------
6+
7+
core.BaseTransfer module
8+
------------------------
9+
10+
.. automodule:: core.BaseTransfer
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
core.Collocation module
16+
-----------------------
17+
18+
.. automodule:: core.Collocation
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
core.Controller module
24+
----------------------
25+
26+
.. automodule:: core.Controller
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
core.Errors module
32+
------------------
33+
34+
.. automodule:: core.Errors
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
core.Hooks module
40+
-----------------
41+
42+
.. automodule:: core.Hooks
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
core.Level module
48+
-----------------
49+
50+
.. automodule:: core.Level
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
core.Problem module
56+
-------------------
57+
58+
.. automodule:: core.Problem
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
core.SpaceTransfer module
64+
-------------------------
65+
66+
.. automodule:: core.SpaceTransfer
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
core.Step module
72+
----------------
73+
74+
.. automodule:: core.Step
75+
:members:
76+
:undoc-members:
77+
:show-inheritance:
78+
79+
core.Sweeper module
80+
-------------------
81+
82+
.. automodule:: core.Sweeper
83+
:members:
84+
:undoc-members:
85+
:show-inheritance:
86+
87+
88+
Module contents
89+
---------------
90+
91+
.. automodule:: core
92+
:members:
93+
:undoc-members:
94+
:show-inheritance:

‎docs/source/pySDC/helpers.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
helpers package
2+
===============
3+
4+
Submodules
5+
----------
6+
7+
helpers.plot\_helper module
8+
---------------------------
9+
10+
.. automodule:: helpers.plot_helper
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
helpers.pysdc\_helper module
16+
----------------------------
17+
18+
.. automodule:: helpers.pysdc_helper
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
helpers.stats\_helper module
24+
----------------------------
25+
26+
.. automodule:: helpers.stats_helper
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
helpers.transfer\_helper module
32+
-------------------------------
33+
34+
.. automodule:: helpers.transfer_helper
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
helpers.visualization\_tools module
40+
-----------------------------------
41+
42+
.. automodule:: helpers.visualization_tools
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
48+
Module contents
49+
---------------
50+
51+
.. automodule:: helpers
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:

‎docs/source/pySDC/implementations.collocation_classes.rst‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
implementations.collocation\_classes package
2+
============================================
3+
4+
Submodules
5+
----------
6+
7+
implementations.collocation\_classes.equidistant module
8+
-------------------------------------------------------
9+
10+
.. automodule:: implementations.collocation_classes.equidistant
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
implementations.collocation\_classes.equidistant\_inner module
16+
--------------------------------------------------------------
17+
18+
.. automodule:: implementations.collocation_classes.equidistant_inner
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
implementations.collocation\_classes.equidistant\_right module
24+
--------------------------------------------------------------
25+
26+
.. automodule:: implementations.collocation_classes.equidistant_right
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
implementations.collocation\_classes.equidistant\_spline\_right module
32+
----------------------------------------------------------------------
33+
34+
.. automodule:: implementations.collocation_classes.equidistant_spline_right
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
implementations.collocation\_classes.gauss\_legendre module
40+
-----------------------------------------------------------
41+
42+
.. automodule:: implementations.collocation_classes.gauss_legendre
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
implementations.collocation\_classes.gauss\_lobatto module
48+
----------------------------------------------------------
49+
50+
.. automodule:: implementations.collocation_classes.gauss_lobatto
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
implementations.collocation\_classes.gauss\_radau\_left module
56+
--------------------------------------------------------------
57+
58+
.. automodule:: implementations.collocation_classes.gauss_radau_left
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
implementations.collocation\_classes.gauss\_radau\_right module
64+
---------------------------------------------------------------
65+
66+
.. automodule:: implementations.collocation_classes.gauss_radau_right
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
71+
72+
Module contents
73+
---------------
74+
75+
.. automodule:: implementations.collocation_classes
76+
:members:
77+
:undoc-members:
78+
:show-inheritance:

‎docs/source/pySDC/implementations.controller_classes.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
implementations.controller\_classes package
2+
===========================================
3+
4+
Submodules
5+
----------
6+
7+
implementations.controller\_classes.controller\_MPI module
8+
----------------------------------------------------------
9+
10+
.. automodule:: implementations.controller_classes.controller_MPI
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
implementations.controller\_classes.controller\_nonMPI module
16+
-------------------------------------------------------------
17+
18+
.. automodule:: implementations.controller_classes.controller_nonMPI
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
24+
Module contents
25+
---------------
26+
27+
.. automodule:: implementations.controller_classes
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:

‎docs/source/pySDC/implementations.datatype_classes.rst‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
implementations.datatype\_classes package
2+
=========================================
3+
4+
Submodules
5+
----------
6+
7+
8+
implementations.datatype\_classes.fenics\_mesh module
9+
-----------------------------------------------------
10+
11+
.. automodule:: implementations.datatype_classes.fenics_mesh
12+
:members:
13+
:undoc-members:
14+
:show-inheritance:
15+
16+
implementations.datatype\_classes.mesh module
17+
---------------------------------------------
18+
19+
.. automodule:: implementations.datatype_classes.mesh
20+
:members:
21+
:undoc-members:
22+
:show-inheritance:
23+
24+
implementations.datatype\_classes.particles module
25+
--------------------------------------------------
26+
27+
.. automodule:: implementations.datatype_classes.particles
28+
:members:
29+
:undoc-members:
30+
:show-inheritance:
31+
32+
implementations.datatype\_classes.petsc\_dmda\_grid module
33+
----------------------------------------------------------
34+
35+
.. automodule:: implementations.datatype_classes.petsc_dmda_grid
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:
39+
40+
41+
Module contents
42+
---------------
43+
44+
.. automodule:: implementations.datatype_classes
45+
:members:
46+
:undoc-members:
47+
:show-inheritance:

‎docs/source/pySDC/implementations.problem_classes.acoustic_helpers.rst‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
implementations.problem\_classes.acoustic\_helpers package
2+
==========================================================
3+
4+
Submodules
5+
----------
6+
7+
implementations.problem\_classes.acoustic\_helpers.buildFDMatrix module
8+
-----------------------------------------------------------------------
9+
10+
.. automodule:: implementations.problem_classes.acoustic_helpers.buildFDMatrix
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
implementations.problem\_classes.acoustic\_helpers.buildWave1DMatrix module
16+
---------------------------------------------------------------------------
17+
18+
.. automodule:: implementations.problem_classes.acoustic_helpers.buildWave1DMatrix
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
implementations.problem\_classes.acoustic\_helpers.standard\_integrators module
24+
-------------------------------------------------------------------------------
25+
26+
.. automodule:: implementations.problem_classes.acoustic_helpers.standard_integrators
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
32+
Module contents
33+
---------------
34+
35+
.. automodule:: implementations.problem_classes.acoustic_helpers
36+
:members:
37+
:undoc-members:
38+
:show-inheritance:

0 commit comments

Comments
 (0)