Skip to content

Commit 1ae38a5

Browse files
phumthepphumthep
committed
Revise API reference docs
1 parent 0d9300d commit 1ae38a5

File tree

8 files changed

+259
-54
lines changed

8 files changed

+259
-54
lines changed

‎docs/source/api_ref/pownet.core.rst‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
pownet.core package
2+
===================
3+
4+
Submodules
5+
----------
6+
17
pownet.core.builder module
28
--------------------------
39

@@ -14,14 +20,6 @@ pownet.core.data\_processor module
1420
:undoc-members:
1521
:show-inheritance:
1622

17-
pownet.core.input module
18-
------------------------
19-
20-
.. automodule:: pownet.core.input
21-
:members:
22-
:undoc-members:
23-
:show-inheritance:
24-
2523
pownet.core.output module
2624
-------------------------
2725

@@ -46,10 +44,26 @@ pownet.core.simulation module
4644
:undoc-members:
4745
:show-inheritance:
4846

47+
pownet.core.user\_constraint module
48+
-----------------------------------
49+
50+
.. automodule:: pownet.core.user_constraint
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
4955
pownet.core.visualizer module
5056
-----------------------------
5157

5258
.. automodule:: pownet.core.visualizer
5359
:members:
5460
:undoc-members:
5561
:show-inheritance:
62+
63+
Module contents
64+
---------------
65+
66+
.. automodule:: pownet.core
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:

‎docs/source/api_ref/pownet.data_model.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
pownet.data\_model package
2+
==========================
3+
4+
Submodules
5+
----------
6+
7+
pownet.data\_model.reservoir module
8+
-----------------------------------
9+
10+
.. automodule:: pownet.data_model.reservoir
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
Module contents
16+
---------------
17+
18+
.. automodule:: pownet.data_model
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:

‎docs/source/api_ref/pownet.modeling.rst‎

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎docs/source/api_ref/pownet.optim_model.constraints.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
pownet.optim\_model.constraints package
2+
=======================================
3+
4+
Submodules
5+
----------
6+
7+
pownet.optim\_model.constraints.energy\_storage\_constr module
8+
--------------------------------------------------------------
9+
10+
.. automodule:: pownet.optim_model.constraints.energy_storage_constr
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
pownet.optim\_model.constraints.nondispatch\_constr module
16+
----------------------------------------------------------
17+
18+
.. automodule:: pownet.optim_model.constraints.nondispatch_constr
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
pownet.optim\_model.constraints.system\_constr module
24+
-----------------------------------------------------
25+
26+
.. automodule:: pownet.optim_model.constraints.system_constr
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
pownet.optim\_model.constraints.thermal\_unit\_constr module
32+
------------------------------------------------------------
33+
34+
.. automodule:: pownet.optim_model.constraints.thermal_unit_constr
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: pownet.optim_model.constraints
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎docs/source/api_ref/pownet.optim_model.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
pownet.optim\_model package
2+
===========================
3+
4+
Subpackages
5+
-----------
6+
7+
.. toctree::
8+
:maxdepth: 4
9+
10+
pownet.optim_model.constraints
11+
12+
Submodules
13+
----------
14+
15+
pownet.optim\_model.model module
16+
--------------------------------
17+
18+
.. automodule:: pownet.optim_model.model
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
pownet.optim\_model.objfunc module
24+
----------------------------------
25+
26+
.. automodule:: pownet.optim_model.objfunc
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
pownet.optim\_model.rounding\_algo module
32+
-----------------------------------------
33+
34+
.. automodule:: pownet.optim_model.rounding_algo
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
pownet.optim\_model.variable module
40+
-----------------------------------
41+
42+
.. automodule:: pownet.optim_model.variable
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Module contents
48+
---------------
49+
50+
.. automodule:: pownet.optim_model
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

‎docs/source/api_ref/pownet.reservoir.rst‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
pownet.reservoir package
2+
========================
3+
4+
Submodules
5+
----------
6+
7+
pownet.reservoir.manager module
8+
-------------------------------
9+
10+
.. automodule:: pownet.reservoir.manager
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
pownet.reservoir.reservoir module
16+
---------------------------------
17+
18+
.. automodule:: pownet.reservoir.reservoir
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
pownet.reservoir.reservoir\_functions module
24+
--------------------------------------------
25+
26+
.. automodule:: pownet.reservoir.reservoir_functions
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
pownet.reservoir.solve\_release module
32+
--------------------------------------
33+
34+
.. automodule:: pownet.reservoir.solve_release
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Module contents
40+
---------------
41+
42+
.. automodule:: pownet.reservoir
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:

‎docs/source/api_ref/pownet.rst‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,22 @@ Subpackages
88
:maxdepth: 4
99

1010
pownet.core
11-
pownet.modeling
11+
pownet.data_model
12+
pownet.optim_model
13+
pownet.reservoir
14+
pownet.stochastic
1215

1316
Submodules
1417
----------
1518

19+
pownet.coupler module
20+
---------------------
21+
22+
.. automodule:: pownet.coupler
23+
:members:
24+
:undoc-members:
25+
:show-inheritance:
26+
1627
pownet.data\_utils module
1728
-------------------------
1829

@@ -29,6 +40,14 @@ pownet.folder\_utils module
2940
:undoc-members:
3041
:show-inheritance:
3142

43+
pownet.input module
44+
-------------------
45+
46+
.. automodule:: pownet.input
47+
:members:
48+
:undoc-members:
49+
:show-inheritance:
50+
3251
Module contents
3352
---------------
3453

‎docs/source/api_ref/pownet.stochastic.rst‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
pownet.stochastic package
2+
=========================
3+
4+
Submodules
5+
----------
6+
7+
pownet.stochastic.demand module
8+
-------------------------------
9+
10+
.. automodule:: pownet.stochastic.demand
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
pownet.stochastic.kirsch\_nowak module
16+
--------------------------------------
17+
18+
.. automodule:: pownet.stochastic.kirsch_nowak
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
pownet.stochastic.solar module
24+
------------------------------
25+
26+
.. automodule:: pownet.stochastic.solar
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
pownet.stochastic.timeseries\_model module
32+
------------------------------------------
33+
34+
.. automodule:: pownet.stochastic.timeseries_model
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
pownet.stochastic.timeseries\_utils module
40+
------------------------------------------
41+
42+
.. automodule:: pownet.stochastic.timeseries_utils
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Module contents
48+
---------------
49+
50+
.. automodule:: pownet.stochastic
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:

0 commit comments

Comments
 (0)