Merge pull request #192 from PowerGridModel/bugfix/add-missing-docs

add missing API docs

docs/converters/pandapower_converter.md

@@ -6,10 +6,15 @@ SPDX-License-Identifier: MPL-2.0
 
 # Pandapower converter
 
-Pandapower converter can convert the pandapower `net` to power-grid-model input data. 
+The pandapower converter can convert the pandapower `net` to power-grid-model input data. 
 It also converts the power flow output of power-grid-model into the `res_*` Dataframes in the pandapower `net`.
 The converter can be used in a similar way as described in [Converters](converter.md).
 
+## Cross referencing
+
+Due to differences between the power-grid-model and pandapower, some components in one model are modeled as multiple components in the other or vise versa.
+An example on how to cross-reference can be found in the [pandapower conversion example](../examples/pandapower_example.ipynb#cross-referencing-objects).
+
 ## Defaults
 
 If any of the essential tap attributes: `tap_pos`, `tap_nom`, `tap_side` are not available then the tap feature for transformers are disabled by setting `tap_nom=tap_pos=0` via conversion.
@@ -20,8 +25,11 @@ If the clocks are odd, then the vector group is converted as `YNynd`, `YNdyn` or
 ## Modelling differences
 
 The user must be aware of following unsupported features or differences in conversion. 
-Currently, the conversions only support powerflow calculations and their relevant attributes.
-Any feature involving a PV bus, ie. generator, DC line are unsupported as of now.
+
+* Currently, the conversions only support powerflow calculations and their relevant attributes.
+* Any feature involving a PV bus, ie. generator, DC line are unsupported as of now.
+
+In addition, the following component-specific modelling differences exist.
 
 ### Load
 

docs/examples/pandapower_example.ipynb

@@ -139,7 +139,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### 2. Validate the data\n",
+    "## 2. Validate the data\n",
     "Before we run a power flow calculation, it is wise validate the data. The most basic method is to use `assert_valid_input_data()`, which will raise a `ValueError` when the data is invalid. For more details on data validation, please consult the [validation Example](https://github.com/PowerGridModel/power-grid-model/blob/main/docs/examples/Validation%20Examples.ipynb)."
    ]
   },
@@ -159,7 +159,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### 3. Run the calculation\n",
+    "## 3. Run the calculation\n",
     "\n",
     "Run powerflow calculation with the `input_data` and show the results for `nodes`."
    ]

docs/power_grid_model_io.md

@@ -6,26 +6,21 @@ SPDX-License-Identifier: MPL-2.0
 
 # power_grid_model_io
 
-## cli
-
-```{eval-rst}
-.. automodule:: power_grid_model_io.cli.convert
-.. automodule:: power_grid_model_io.cli.validate
-```
-
 ## converters
 
 ```{eval-rst}
 .. automodule:: power_grid_model_io.converters.base_converter
+.. automodule:: power_grid_model_io.converters.pgm_json_converter
 .. automodule:: power_grid_model_io.converters.tabular_converter
+.. automodule:: power_grid_model_io.converters.pandapower_converter
 .. automodule:: power_grid_model_io.converters.vision_excel_converter
-.. automodule:: power_grid_model_io.converters.pgm_json_converter
 ```
 
 ## data_stores
 
 ```{eval-rst}
 .. automodule:: power_grid_model_io.data_stores.base_data_store
+.. automodule:: power_grid_model_io.data_stores.csv_file_store
 .. automodule:: power_grid_model_io.data_stores.excel_file_store
 .. automodule:: power_grid_model_io.data_stores.json_file_store
 .. automodule:: power_grid_model_io.data_stores.vision_excel_file_store
@@ -34,6 +29,7 @@ SPDX-License-Identifier: MPL-2.0
 ## data_types
 
 ```{eval-rst}
+.. automodule:: power_grid_model_io.data_types._data_types
 .. automodule:: power_grid_model_io.data_types.tabular_data
 ```
 
@@ -46,6 +42,8 @@ SPDX-License-Identifier: MPL-2.0
 ## mappings
 
 ```{eval-rst}
+.. automodule:: power_grid_model_io.mappings.field_mapping
+.. automodule:: power_grid_model_io.mappings.multiplier_mapping
 .. automodule:: power_grid_model_io.mappings.tabular_mapping
 .. automodule:: power_grid_model_io.mappings.unit_mapping
 .. automodule:: power_grid_model_io.mappings.value_mapping
@@ -55,5 +53,10 @@ SPDX-License-Identifier: MPL-2.0
 
 ```{eval-rst}
 .. automodule:: power_grid_model_io.utils.auto_id
+.. automodule:: power_grid_model_io.utils.dict
+.. automodule:: power_grid_model_io.utils.download
+.. automodule:: power_grid_model_io.utils.json
 .. automodule:: power_grid_model_io.utils.modules
+.. automodule:: power_grid_model_io.utils.regex
+.. automodule:: power_grid_model_io.utils.zip
 ```