Merge pull request #650 from openego/documentation-release0.9.0-fix_a…

…pi_doc

Documentation release0.9.0 fix api doc

README.rst

@@ -19,14 +19,16 @@ eTraGo
 Optimization of flexibility options for transmission grids based on PyPSA
 
 A speciality in this context is that transmission grids are described by the
-380, 220 and 110 kV in Germany. Conventionally the 110kV grid is part of the
+380, 220 and 110 kV in Germany. Conventionally, the 110kV grid is part of the
 distribution grid. The integration of the transmission and 'upper' distribution
 grid is part of eTraGo.
 
 The focus of optimization are flexibility options with a special focus on
 energy storages. Grid expansion measures are not part of this tool and will be
 instead part of 'eGo' https://github.com/openego/eGo
 
+eTraGo is documented on `readthedocs <https://etrago.readthedocs.io>`_.
+
 .. warning::
   From now on eTraGo depends on a sector coupled data-model. This is not published on 
   the oedb yet, the data has to be created using
@@ -35,7 +37,6 @@ instead part of 'eGo' https://github.com/openego/eGo
 
   When you want to use eTraGo for optimizations, please use the latest release 0.8.0. 
 
-
 Installation
 ============
 eTraGo is designed as a Python package therefore it is mandatory to have

doc/api.rst

@@ -1,8 +1,11 @@
-.. make doc-string generated documentation appear here
+API
+====
 
 .. toctree::
    :maxdepth: 7
    :glob:
    :titlesonly:
 
-   API <api/modules>
+   api/etrago.cluster
+   api/etrago.tools
+   api/appl.rst

doc/api/appl.rst

@@ -0,0 +1,7 @@
+etrago.appl module
+-------------------
+
+.. automodule:: etrago.appl
+    :members:
+    :undoc-members:
+    :show-inheritance:

doc/api/etrago.cluster.rst

@@ -1,30 +1,42 @@
-etrago\.cluster package
+etrago.cluster package
 =======================
 
-Submodules
-----------
+etrago.cluster.disaggregation module
+-----------------------------------------
 
-etrago\.cluster\.networkclustering module
+.. automodule:: etrago.cluster.disaggregation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+etrago.cluster.electrical module
 -----------------------------------------
 
-.. automodule:: etrago.cluster.networkclustering
+.. automodule:: etrago.cluster.electrical
     :members:
     :undoc-members:
     :show-inheritance:
 
-etrago\.cluster\.snapshot module
+etrago.cluster.gas module
+-----------------------------------------
+
+.. automodule:: etrago.cluster.gas
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+etrago.cluster.snapshot module
 --------------------------------
 
 .. automodule:: etrago.cluster.snapshot
     :members:
     :undoc-members:
     :show-inheritance:
 
-Module contents
----------------
+etrago.cluster.spatial module
+--------------------------------
 
-.. automodule:: etrago.cluster
+.. automodule:: etrago.cluster.spatial
     :members:
     :undoc-members:
     :show-inheritance:
-

doc/api/etrago.tools.rst

@@ -1,56 +1,66 @@
-etrago\.tools package
+etrago.tools package
 =====================
 
-Submodules
-----------
+etrago.tools.calc\_results module
+----------------------------------
 
-etrago\.tools\.io module
-------------------------
+.. automodule:: etrago.tools.calc_results
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
-.. automodule:: etrago.tools.io
+etrago.tools.constraints module
+----------------------------------
+
+.. automodule:: etrago.tools.constraints
     :members:
     :undoc-members:
     :show-inheritance:
 
+etrago.tools.execute module
+----------------------------------
 
-etrago\.tools\.extendable module
-------------------------
+.. automodule:: etrago.tools.execute
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+etrago.tools.extendable module
+----------------------------------
 
 .. automodule:: etrago.tools.extendable
     :members:
     :undoc-members:
     :show-inheritance:
 
+etrago.tools.io module
+------------------------
 
-etrago\.tools\.plot module
---------------------------
-
-.. automodule:: etrago.tools.plot
+.. automodule:: etrago.tools.io
     :members:
     :undoc-members:
     :show-inheritance:
 
-etrago\.tools\.snapshot\_clustering module
-------------------------------------------
+etrago.tools.network module
+-----------------------------
 
-.. automodule:: etrago.tools.snapshot_clustering
+.. automodule:: etrago.tools.network
     :members:
     :undoc-members:
     :show-inheritance:
 
-etrago\.tools\.utilities module
--------------------------------
+etrago.tools.plot module
+---------------------------
 
-.. automodule:: etrago.tools.utilities
+.. automodule:: etrago.tools.plot
     :members:
     :undoc-members:
     :show-inheritance:
 
+etrago.tools.utilities module
+-------------------------------
 
-Module contents
----------------
-
-.. automodule:: etrago.tools
+.. automodule:: etrago.tools.utilities
     :members:
     :undoc-members:
     :show-inheritance:

doc/conf.py

@@ -122,7 +122,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "English"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

doc/theoretical_background.rst

@@ -78,7 +78,7 @@ As shown in the figure above, several options to store energy are part of the mo
 
 
 Miscellaneous Features
---------
+----------------------
 
 Several features were developed to enhance the functionality of eTraGo. 
 

doc/whatsnew/v0_5_1.rst

@@ -1,5 +1,5 @@
 Release 0.5.1 (February 01, 2018)
-++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++
 eTraGo works with ego.io 0.3.0
 
 

doc/whatsnew/v0_6_1.rst

@@ -1,5 +1,5 @@
 Release 0.6.1 (Juli 18, 2018)
-++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++
 eTraGo works with pypi and is suitable for eGo 0.2.0
 
 Added features

doc/whatsnew/v0_7_0.rst

@@ -1,9 +1,9 @@
 Release 0.7.0 (September 6, 2018)
-++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++
 eTraGo is able to produce feasible non-linear power flows based on optimization results and allows the disaggregation of clustered results to original spatial complexities. 
 
 Added features
---------------
+---------------
 
 * The pf_post_lopf function was improved. Due to changes in the data set now the non-linear power flow (pf) creates feasible solutions. If network optimization is turned on, a second lopf which regards the updated reactances and optimizes only dispatch is performed before the pf is executed.
 * The disaggregation method was included. When using a network clustering method to reduce the spatial complexity of the given network, a disaggregation method can be used afterwards to distribute the nodal results (generation and storage timeseries) to the original complexity. The method 'disaggregation': 'uniform' can be used as an interface functionality for distribution grid planning tools like eDisGo. 

doc/whatsnew/v0_7_1.rst

@@ -1,5 +1,5 @@
 Release 0.7.1 (October 25, 2018)
-++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++
 A minor release adding new options for additional constraints, modelling assumptions and plotting.
 
 Added features

doc/whatsnew/v0_7_2.rst

@@ -1,5 +1,5 @@
 Release 0.7.2 (Juni 15, 2020)
-++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++
 A minor release adding the following features.
 
 Added features

doc/whatsnew/v0_8_0.rst

@@ -1,5 +1,5 @@
 Release 0.8.0 (April 8, 2021)
-++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++
 eTraGo has now a more object-oriented programming design.
 
 Added features