Repair reference links #434

OpenEnergyPlatform · Sep 27, 2023 · 5526613 · 5526613
1 parent 7101a12
commit 5526613
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/open_mastr/mastr.py b/open_mastr/mastr.py
@@ -140,7 +140,7 @@ def download(
             | None      | set date="today"  | set date="latest"   |
 
             Default to `None`.
-        bulk_cleansing : bool, optional            
+        bulk_cleansing : bool, optional
             If True, data cleansing is applied after the download (which is recommended). Default
             to True.
         api_processes : int or None or "max", optional
@@ -155,7 +155,7 @@ def download(
         api_limit : int or None, optional
             Limit the number of units that data is downloaded for. Defaults to `None` which refers
             to query data for existing data requests, for example created by
-            [`create_additional_data_requests`][open_mastr.soap_api.mirror.create_additional_data_requests]. Note: There is a limited number of
+            [`create_additional_data_requests`][open_mastr.soap_api.mirror.MaStRMirror.create_additional_data_requests]. Note: There is a limited number of
             requests you are allowed to have per day, so setting api_limit to a value is
             recommended.
         api_chunksize : int or None, optional

diff --git a/open_mastr/soap_api/download.py b/open_mastr/soap_api/download.py
@@ -29,7 +29,7 @@ class MaStRAPI(object):
     """
     Access the Marktstammdatenregister (MaStR) SOAP API via a Python wrapper
 
-    Read about [MaStR account and credentials](../advanced/api_download.md#MaStR account and credentials)
+    Read about [MaStR account and credentials](/advanced/#mastr-account-and-credentials)
     how to create a user account and a role including a token to access the
     MaStR SOAP API.
 
@@ -45,7 +45,7 @@ class MaStRAPI(object):
 
     Alternatively, leave `user` and `key` empty if user and token are accessible via
     `credentials.cfg`. How to configure this is described
-    [here](../advanced/api_download.md#MaStR account and credentials).
+    [here](/advanced/#mastr-account-and-credentials).
 
     ```python
 
@@ -416,7 +416,7 @@ def _missed_units_to_file(data, data_type, missed_units):
 class MaStRDownload:
     """Use the higher level interface for bulk download
 
-    `MaStRDownload` builds on top of [`MaStRAPI`][open_mastr.soap_api.MaStRAPI] and provides
+    `MaStRDownload` builds on top of [`MaStRAPI`][open_mastr.soap_api.download.MaStRAPI] and provides
     an interface for easier downloading.
     Use methods documented below to retrieve specific data. On the example of
     data for nuclear power plants, this looks like

diff --git a/open_mastr/soap_api/mirror.py b/open_mastr/soap_api/mirror.py
@@ -63,7 +63,7 @@ class MaStRMirror:
     ```
 
     The data can be joined to one table for each data type and exported to
-    CSV files using [`MaStRMirror.to_csv`][open_mastr.soap_api.mirror.MaStRMirror.to_csv].
+    CSV files using [`Mastr.to_csv`][open_mastr.mastr.Mastr.to_csv].
 
     Also consider to use `~.dump` and `~.restore` for specific purposes.