Fix sphinx warnings

openego · Feb 7, 2024 · 7dcdb02 · 7dcdb02
1 parent 01129ba
commit 7dcdb02
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 55 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -29,11 +29,12 @@ Added
   returns the current configuration settings. See `PR #159`_ for more
   details.
 * You can now use tasks which are not part of a ``Dataset``, i.e. which
-  are unversioned, as dependencies of a dataset. See `PR #318`_ for more
+  are unversioned, as dependencies of a dataset. See
+  `#318 <https://github.com/openego/eGon-data/issues/318>`_ for more
   details.
 * You can now force the tasks of a ``Dataset`` to be always executed by
-  giving the version of the ``Dataset`` a ``".dev"`` suffix. See `PR
-  #318`_ for more details.
+  giving the version of the ``Dataset`` a ``".dev"`` suffix. See
+  `#318 <https://github.com/openego/eGon-data/issues/318>`_ for more details.
 * OSM data import as done in open_ego
   `#1 <https://github.com/openego/eGon-data/issues/1>`_
   which was updated to the latest long-term data set of the 2021-01-01

diff --git a/docs/data/DLR.rst b/docs/data/DLR.rst
@@ -1,10 +1,6 @@
-====================================================
-Methods to include dynamic line rating in our model
-====================================================
-
-To calculate the transmission capacity of each transmission line in the model, 
+To calculate the transmission capacity of each transmission line in the model,
 the procedure suggested in the **Principles for the Expansion Planning of the
-German Transmission Network** [NEP2021] where used:
+German Transmission Network** [NEP2021a]_ where used:
 
 1. Import the temperature and wind temporal raster layers from ERA-5. Hourly
 resolution data from the year 2011 was used. Raster resolution
@@ -16,8 +12,8 @@ the Expansion Planning. See Figure 1.
 .. image:: images/regions_DLR.png
   :width: 400
   :alt: regions DLR
-  
-Figure 1: Representative regions in Germany for DLR analysis [NEP2021]
+
+Figure 1: Representative regions in Germany for DLR analysis [NEP2021a]_
 
 3. Find the lowest wind speed in each region. To perform this, for each
 independent region, the wind speed of every cell in the raster layer should be
@@ -35,13 +31,11 @@ Figure 2.
 .. image:: images/table_max_capacity_DLR.png
   :width: 400
   :alt: table_max_capacity_DLR
-  
-Figure 2: transmission capacity based on max temperature and min wind speed [NEP2021]
+
+Figure 2: transmission capacity based on max temperature and min wind speed [NEP2021a]_
 
 6. Assign the maximum capacity of the corresponding region to each transmission
 line inside each one of them. Crossborder lines and underground lines receive
 no values. It means that their capacities are static and equal to their nominal
-values. Lines that cross borders between regions receive the lowest 
+values. Lines that cross borders between regions receive the lowest
 capacity per hour of the regions containing the line.
-
-.. [NEP2021] Principles for the Expansion Planning of the German Transmission Network https://www.netzentwicklungsplan.de/
diff --git a/docs/data/electricity_supply.rst b/docs/data/electricity_supply.rst
@@ -33,7 +33,7 @@ The following steps are conducted:
 
 #. If expansion of wind onshore capacity is required, capacities are calculated depending on the area size of the formerly selected potential areas. 21.05 MW/km² and 16.81 MW/km² are used for federal states in the north and in the south of the country respectively. The resulting parks are therefore located on the selected potential areas.
 
-#. The resulting capacities are compared to the target values for the specific scenario per federal state. If the target value is exceeded, a linear downscaling is conducted. If the target value is not reached yet, the remaining capacity is distributed linearly among the rest of the potential areas within the state. 
+#. The resulting capacities are compared to the target values for the specific scenario per federal state. If the target value is exceeded, a linear downscaling is conducted. If the target value is not reached yet, the remaining capacity is distributed linearly among the rest of the potential areas within the state.
 
 Offshore wind
 ++++++++++++++
@@ -52,10 +52,11 @@ The following steps are conducted:
 
 .. figure:: /images/offshore_power_plants_areas.png
   :name: offshore_power_plants_areas
-  :width: 400 
-  
+  :width: 400
+
   Areas for offshore wind park in North and Baltic sea. Source: NEP
 
+.. _pv-rooftop-ref:
 
 PV ground mounted
 ++++++++++++++++++
@@ -74,12 +75,12 @@ The following steps are conducted:
 
 #. If expansion of PV ground mounted capacity is required, capacities are calculated depending on the area size of the formerly selected potential areas. The resulting parks are therefore located on the selected potential areas.
 
-#. The resulting capacities are compared to the target values for the specific scenario per federal state. If the target value is exceeded, a linear downscaling is conducted. If the target value is not reached yet, the remaining capacity is distributed linearly among the rest of the potential areas within the state. 
+#. The resulting capacities are compared to the target values for the specific scenario per federal state. If the target value is exceeded, a linear downscaling is conducted. If the target value is not reached yet, the remaining capacity is distributed linearly among the rest of the potential areas within the state.
 
 .. figure:: /images/PV_freiflaeche.png
   :name: pv_ground_mounted-example
-  :width: 400 
-  
+  :width: 400
+
   Example: sites of existing PV ground mounted parks and potential areas
 
 PV rooftop
@@ -140,18 +141,18 @@ Disaggregation of PV rooftop scenario capacities:
 Hydro
 +++++
 
-In the case of hydropower plants, a distinction is made between the carrier run-of-river 
-and reservoir. 
+In the case of hydropower plants, a distinction is made between the carrier run-of-river
+and reservoir.
 The methods to distribute and allocate are the same for both carriers.
-In a first step all suitable power plants (correct carrier, valid geolocation, information 
+In a first step all suitable power plants (correct carrier, valid geolocation, information
 about federal state) are selected and their installed capacity is scaled to meet the target
-values for the respective federal state and scenario. 
-Information about the voltage level the power plants are connected to is obtained. In case 
-no information is availabe the voltage level is identified using threshold values for the 
-installed capacity (see :func:`assign_voltage_level <egon.data.datasets.power_plants.assign_voltage_level>`). 
+values for the respective federal state and scenario.
+Information about the voltage level the power plants are connected to is obtained. In case
+no information is availabe the voltage level is identified using threshold values for the
+installed capacity (see :func:`assign_voltage_level <egon.data.datasets.power_plants.assign_voltage_level>`).
 In a next step the correct grid connection point is identified based on the voltage level
 and geolocation of the power plants (see :func:`assign_bus_id <egon.data.datasets.power_plants.assign_bus_id>`)
-The resulting list of power plants it added to table 
+The resulting list of power plants it added to table
 :py:class:`EgonPowerPlants <egon.data.datasets.power_plants.EgonPowerPlants>`.
 
 Biomass
@@ -172,9 +173,9 @@ Conventional
 
 
 In function :func:`allocate_conventional_non_chp_power_plants <egon.data.datasets.power_plants.allocate_conventional_non_chp_power_plants>`
-capacities for conventional power plants, which are no chp plants, with carrier *oil* and 
+capacities for conventional power plants, which are no chp plants, with carrier *oil* and
 *gas* are allocated.
-  
+
 
 
 

diff --git a/docs/data/gas_grids.rst b/docs/data/gas_grids.rst
@@ -1,20 +1,20 @@
 The gas grid data stems from the *SciGRID_gas project* (https://www.gas.scigrid.de/) which covers the European Gas
-Transmission Grid. All data generated in the *SciGRID_gas* project is licenced under 
+Transmission Grid. All data generated in the *SciGRID_gas* project is licenced under
 *Creative Commons Attribution 4.0 International Public License*.
 The specific dataset version is IGGIELGN and can be downloaded at https://zenodo.org/record/4767098.
-*SciGRID_gas* contains extensive data on pipelines, storages, LNGs, productions, consumers and more. 
+*SciGRID_gas* contains extensive data on pipelines, storages, LNGs, productions, consumers and more.
 Further information can be obtained in the IGGIELGN documentation.
 For eGon-data, *SciGRID_gas* infrastructure data in Germany has been extracted and used in full resolution
 while data of neighboring countries has been aggregated.
 
 
-Methane grid 
-~~~~~~~~~~~~
-In the eGon2035 scenario the methane grid is, apart from minor adjustments, equivalent to the gas grid described in the 
+Methane grid
+++++++++++++++
+In the eGon2035 scenario the methane grid is, apart from minor adjustments, equivalent to the gas grid described in the
 *SciGRID_gas IGGIELGN* dataset.
 
 Hydrogen grid
-~~~~~~~~~~~~~
+++++++++++++++
 In the eGon2035 scenario H2 nodes are present at every methane bus (H2_grid) and at locations where there
-are possible H2 cavern storages available (H2_saltcavern). There is no explicit H2 pipeline grid available but H2 can 
-be transported using the methane grid. 
+are possible H2 cavern storages available (H2_saltcavern). There is no explicit H2 pipeline grid available but H2 can
+be transported using the methane grid.
diff --git a/docs/data/heat_demand.rst b/docs/data/heat_demand.rst
@@ -1,4 +1,3 @@
-.. _heat_demand:
 Heat demands comprise space heating and drinking hot water demands from
 residential and commercial trade and service (CTS) buildings.
 Process heat demands from the industry are, depending on the required temperature

diff --git a/docs/literature.rst b/docs/literature.rst
@@ -44,6 +44,8 @@ Literature
 
 .. [NEP2021] Übertragungsnetzbetreiber Deutschland (2021):  *Netzentwicklungsplan Strom 2035*, Version 2021, 1. Entwurf. 2021.
 
+.. [NEP2021a] Principles for the Expansion Planning of the German Transmission Network https://www.netzentwicklungsplan.de/
+
 .. [NOW2020] Nationale Leitstelle Ladeinfrastruktur, Ladeinfrastruktur nach 2025/2030: Szenarien für den Markthochlauf (2020). URL https://www.now-gmbh.de/wp-content/uploads/2020/11/Studie_Ladeinfrastruktur-nach-2025-2.pdf
 
 .. [OSM] Geofabrik GmbH and OpenStreetMap-Contributors, OpenStreetMap Data Extracts, Stand 01.01.2022 (2022). URL https://download.geofabrik.de/europe/germany-220101.osm.pbf

diff --git a/docs/reference/egon.data.airflow.rst b/docs/reference/egon.data.airflow.rst
@@ -3,8 +3,7 @@
 airflow
 =======
 
+.. toctree::
+   :maxdepth: 1
 
-.. automodule:: egon.data.airflow
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   egon.data.airflow.dags
diff --git a/docs/reference/egon.data.dataset_configuration.rst b/docs/reference/egon.data.dataset_configuration.rst
diff --git a/docs/reference/egon.data.rst b/docs/reference/egon.data.rst
@@ -10,7 +10,6 @@ egon.data
    egon.data.airflow
    egon.data.cli
    egon.data.config
-   egon.data.dataset_configuration
    egon.data.datasets
    egon.data.db
    egon.data.metadata

diff --git a/src/egon/data/db.py b/src/egon/data/db.py
@@ -360,10 +360,10 @@ def commit(*args, **kwargs):
 
 
 def assign_gas_bus_id(dataframe, scn_name, carrier):
-    """Assign `bus_id`s to points according to location.
+    """Assign `bus_id`'s to points according to location.
 
     The points are taken from the given `dataframe` and the geometries by
-    which the `bus_id`s are assigned to them are taken from the
+    which the `bus_id`'s are assigned to them are taken from the
     `grid.egon_gas_voronoi` table.
 
     Parameters