Skip to content

Commit c42d3af

Browse files
harryswift01harryswift01
committed
docs: update auto api docs with changes made to branch #358 
1 parent eb2c4bf commit c42d3af

18 files changed

Lines changed: 145 additions & 379 deletions

‎docs/api/CodeEntropy.config.rst‎

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,16 @@
11
CodeEntropy.config package
22
==========================
33

4-
Submodules
5-
----------
6-
7-
CodeEntropy.config.argparse module
8-
----------------------------------
9-
10-
.. automodule:: CodeEntropy.config.argparse
4+
.. automodule:: CodeEntropy.config
115
:members:
126
:show-inheritance:
137
:undoc-members:
148

15-
CodeEntropy.config.runtime module
16-
---------------------------------
17-
18-
.. automodule:: CodeEntropy.config.runtime
19-
:members:
20-
:show-inheritance:
21-
:undoc-members:
9+
Submodules
10+
----------
2211

23-
Module contents
24-
---------------
12+
.. toctree::
13+
:maxdepth: 4
2514

26-
.. automodule:: CodeEntropy.config
27-
:members:
28-
:show-inheritance:
29-
:undoc-members:
15+
CodeEntropy.config.argparse
16+
CodeEntropy.config.runtime

‎docs/api/CodeEntropy.core.dask_clusters.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
CodeEntropy.core.dask\_clusters module
2+
======================================
3+
4+
.. automodule:: CodeEntropy.core.dask_clusters
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:

‎docs/api/CodeEntropy.core.rst‎

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,16 @@
11
CodeEntropy.core package
22
========================
33

4-
Submodules
5-
----------
6-
7-
CodeEntropy.core.dask\_clusters module
8-
--------------------------------------
9-
10-
.. automodule:: CodeEntropy.core.dask_clusters
4+
.. automodule:: CodeEntropy.core
115
:members:
126
:show-inheritance:
137
:undoc-members:
148

15-
CodeEntropy.core.logging module
16-
-------------------------------
17-
18-
.. automodule:: CodeEntropy.core.logging
19-
:members:
20-
:show-inheritance:
21-
:undoc-members:
9+
Submodules
10+
----------
2211

23-
Module contents
24-
---------------
12+
.. toctree::
13+
:maxdepth: 4
2514

26-
.. automodule:: CodeEntropy.core
27-
:members:
28-
:show-inheritance:
29-
:undoc-members:
15+
CodeEntropy.core.dask_clusters
16+
CodeEntropy.core.logging

‎docs/api/CodeEntropy.entropy.nodes.rst‎

Lines changed: 9 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,18 @@
11
CodeEntropy.entropy.nodes package
22
=================================
33

4-
Submodules
5-
----------
6-
7-
CodeEntropy.entropy.nodes.aggregate module
8-
------------------------------------------
9-
10-
.. automodule:: CodeEntropy.entropy.nodes.aggregate
11-
:members:
12-
:show-inheritance:
13-
:undoc-members:
14-
15-
CodeEntropy.entropy.nodes.configurational module
16-
------------------------------------------------
17-
18-
.. automodule:: CodeEntropy.entropy.nodes.configurational
19-
:members:
20-
:show-inheritance:
21-
:undoc-members:
22-
23-
CodeEntropy.entropy.nodes.orientational module
24-
----------------------------------------------
25-
26-
.. automodule:: CodeEntropy.entropy.nodes.orientational
4+
.. automodule:: CodeEntropy.entropy.nodes
275
:members:
286
:show-inheritance:
297
:undoc-members:
308

31-
CodeEntropy.entropy.nodes.vibrational module
32-
--------------------------------------------
33-
34-
.. automodule:: CodeEntropy.entropy.nodes.vibrational
35-
:members:
36-
:show-inheritance:
37-
:undoc-members:
9+
Submodules
10+
----------
3811

39-
Module contents
40-
---------------
12+
.. toctree::
13+
:maxdepth: 4
4114

42-
.. automodule:: CodeEntropy.entropy.nodes
43-
:members:
44-
:show-inheritance:
45-
:undoc-members:
15+
CodeEntropy.entropy.nodes.aggregate
16+
CodeEntropy.entropy.nodes.configurational
17+
CodeEntropy.entropy.nodes.orientational
18+
CodeEntropy.entropy.nodes.vibrational

‎docs/api/CodeEntropy.entropy.rst‎

Lines changed: 13 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
CodeEntropy.entropy package
22
===========================
33

4+
.. automodule:: CodeEntropy.entropy
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:
8+
49
Subpackages
510
-----------
611

@@ -12,58 +17,12 @@ Subpackages
1217
Submodules
1318
----------
1419

15-
CodeEntropy.entropy.configurational module
16-
------------------------------------------
17-
18-
.. automodule:: CodeEntropy.entropy.configurational
19-
:members:
20-
:show-inheritance:
21-
:undoc-members:
22-
23-
CodeEntropy.entropy.graph module
24-
--------------------------------
25-
26-
.. automodule:: CodeEntropy.entropy.graph
27-
:members:
28-
:show-inheritance:
29-
:undoc-members:
30-
31-
CodeEntropy.entropy.orientational module
32-
----------------------------------------
33-
34-
.. automodule:: CodeEntropy.entropy.orientational
35-
:members:
36-
:show-inheritance:
37-
:undoc-members:
38-
39-
CodeEntropy.entropy.vibrational module
40-
--------------------------------------
41-
42-
.. automodule:: CodeEntropy.entropy.vibrational
43-
:members:
44-
:show-inheritance:
45-
:undoc-members:
46-
47-
CodeEntropy.entropy.water module
48-
--------------------------------
49-
50-
.. automodule:: CodeEntropy.entropy.water
51-
:members:
52-
:show-inheritance:
53-
:undoc-members:
54-
55-
CodeEntropy.entropy.workflow module
56-
-----------------------------------
57-
58-
.. automodule:: CodeEntropy.entropy.workflow
59-
:members:
60-
:show-inheritance:
61-
:undoc-members:
62-
63-
Module contents
64-
---------------
20+
.. toctree::
21+
:maxdepth: 4
6522

66-
.. automodule:: CodeEntropy.entropy
67-
:members:
68-
:show-inheritance:
69-
:undoc-members:
23+
CodeEntropy.entropy.configurational
24+
CodeEntropy.entropy.graph
25+
CodeEntropy.entropy.orientational
26+
CodeEntropy.entropy.vibrational
27+
CodeEntropy.entropy.water
28+
CodeEntropy.entropy.workflow

‎docs/api/CodeEntropy.levels.execution.chunks.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
CodeEntropy.levels.execution.chunks module
2+
==========================================
3+
4+
.. automodule:: CodeEntropy.levels.execution.chunks
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:

‎docs/api/CodeEntropy.levels.execution.policy.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
CodeEntropy.levels.execution.policy module
2+
==========================================
3+
4+
.. automodule:: CodeEntropy.levels.execution.policy
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:

‎docs/api/CodeEntropy.levels.execution.reducers.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
CodeEntropy.levels.execution.reducers module
2+
============================================
3+
4+
.. automodule:: CodeEntropy.levels.execution.reducers
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:

‎docs/api/CodeEntropy.levels.execution.rst‎

Lines changed: 10 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,19 @@
11
CodeEntropy.levels.execution package
22
====================================
33

4-
Submodules
5-
----------
6-
7-
CodeEntropy.levels.execution.chunks module
8-
------------------------------------------
9-
10-
.. automodule:: CodeEntropy.levels.execution.chunks
11-
:members:
12-
:show-inheritance:
13-
:undoc-members:
14-
15-
CodeEntropy.levels.execution.policy module
16-
------------------------------------------
17-
18-
.. automodule:: CodeEntropy.levels.execution.policy
19-
:members:
20-
:show-inheritance:
21-
:undoc-members:
22-
23-
CodeEntropy.levels.execution.reducers module
24-
--------------------------------------------
25-
26-
.. automodule:: CodeEntropy.levels.execution.reducers
27-
:members:
28-
:show-inheritance:
29-
:undoc-members:
30-
31-
CodeEntropy.levels.execution.scheduler module
32-
---------------------------------------------
33-
34-
.. automodule:: CodeEntropy.levels.execution.scheduler
4+
.. automodule:: CodeEntropy.levels.execution
355
:members:
366
:show-inheritance:
377
:undoc-members:
388

39-
CodeEntropy.levels.execution.tasks module
40-
-----------------------------------------
41-
42-
.. automodule:: CodeEntropy.levels.execution.tasks
43-
:members:
44-
:show-inheritance:
45-
:undoc-members:
9+
Submodules
10+
----------
4611

47-
Module contents
48-
---------------
12+
.. toctree::
13+
:maxdepth: 4
4914

50-
.. automodule:: CodeEntropy.levels.execution
51-
:members:
52-
:show-inheritance:
53-
:undoc-members:
15+
CodeEntropy.levels.execution.chunks
16+
CodeEntropy.levels.execution.policy
17+
CodeEntropy.levels.execution.reducers
18+
CodeEntropy.levels.execution.scheduler
19+
CodeEntropy.levels.execution.tasks

‎docs/api/CodeEntropy.levels.execution.scheduler.rst‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
CodeEntropy.levels.execution.scheduler module
2+
=============================================
3+
4+
.. automodule:: CodeEntropy.levels.execution.scheduler
5+
:members:
6+
:show-inheritance:
7+
:undoc-members:

0 commit comments

Comments
 (0)