[Documentation] Fix broken links (#3129)

* Fix links * Add todo in README.md * Links to developer/repositories * Tutorials and a few corrections Signed-off-by: Coline PILOQUET <[email protected]>
powsybl · Sep 19, 2024 · 399b04d · 399b04d
1 parent e9e9053
commit 399b04d
Show file tree

Hide file tree

Showing 12 changed files with 28 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ By participating, you are expected to uphold this code. Please report unacceptab
 
 This document describes how to build the code of PowSyBl Core. If you just want to run PowSyBl demos, please visit
 https://www.powsybl.org/ where downloads will be available soon. If you want guidance on how to start building your own
-application based on PowSyBl, please visit the [tutorials](https://www.powsybl.org/pages/documentation/developer/tutorials/) page.
+application based on PowSyBl, please visit the [tutorials](https://powsybl.readthedocs.io/projects/powsybl-tutorials/) page.
 
 The PowSyBl Core project is not a standalone project. Read on to learn how to modify the core code, be it for fun, for
 diagnosing bugs, for improving your understanding of the framework, or for preparing pull requests to suggest improvements!

diff --git a/docs/conf.py b/docs/conf.py
@@ -126,8 +126,12 @@
 
 todo_include_todos = True
 
-# Links to external documentations : python 3 and pandas
+# Links to external documentations
 intersphinx_mapping = {
+    "powsyblopenloadflow": ("https://powsybl.readthedocs.io/projects/powsybl-open-loadflow/en/latest/", None),
+    "powsybldynawo": ("https://powsybl.readthedocs.io/projects/powsybl-dynawo/en/latest/", None),
+    "powsybldiagram": ("https://powsybl.readthedocs.io/projects/powsybl-diagram/latest/", None),
+    "powsybltutorials": ("https://powsybl.readthedocs.io/projects/powsybl-tutorials/en/latest/", None)
 }
 intersphinx_disabled_reftypes = ["*"]
 

diff --git a/docs/grid_exchange_formats/cgmes/import.md b/docs/grid_exchange_formats/cgmes/import.md
@@ -519,7 +519,7 @@ Optional property that defines which naming strategy is used to transform CGMES
 **iidm.import.cgmes.post-processors**  
 Optional property that defines all the CGMES post-processors which will be activated after import.
 By default, it is an empty list.
-One implementation of such a post-processor is available in PowSyBl in the [powsybl-diagram](../../developer/repositories/powsybl-diagram.md) repository, named [CgmesDLImportPostProcessor](./post_processor.md#cgmesdlimportpostprocessor).
+One implementation of such a post-processor is available in PowSyBl in the [powsybl-diagram](https://github.com/powsybl/powsybl-diagram) repository, named [CgmesDLImportPostProcessor](./post_processor.md#cgmesdlimportpostprocessor).
 
 **iidm.import.cgmes.powsybl-triplestore**  
 Optional property that defines which Triplestore implementation is used. Currently, PowSyBl only supports [RDF4J](https://rdf4j.org/). `rdf4j` by default.

diff --git a/docs/grid_model/extensions.md b/docs/grid_model/extensions.md
@@ -7,7 +7,7 @@ The extensions can be attached to any objects of a network or to the network its
 
 Some extensions are mono-variant, meaning the data are identical for all the variants of the network. However, some of them are multi-variants to allow a different value for each variant of the network. It's typically the case for the [LoadDetail](#load-detail) extension that give the distribution of the constant part and the thermosensitive part of the consumption. 
 
-Note that some extensions provided by PowSyBl aren't supported in the [persistent implementation of IIDM](../../developer/repositories/powsybl-network-store-server.md).
+Note that some extensions provided by PowSyBl aren't supported in the [persistent implementation of IIDM](https://github.com/powsybl/powsybl-network-store-server).
 
 Every extension is considered as serializable unless explicitly specified as non-serializable in XML-IIDM.
 
@@ -376,7 +376,7 @@ three-winding transformers, HVDC line and a dangling line. The status could be:
 This extension is attached to a Generator, or a BusBarSection or a Load and is used to define the angle reference bus of
 a power flow calculation, i.e. which bus will be used with a zero-voltage angle.
 Use this extension before a computation to force the reference bus selection.
-The support of this feature by Load Flow implementations may vary. For example, the [OpenLoadFlow](../simulation/powerflow/openlf.md) implementation
+The support of this feature by Load Flow implementations may vary. For example, the [OpenLoadFlow](inv:powsyblopenloadflow:*:*#index) implementation
 today supports Reference Priorities on generators only when this feature is activated.
 
 The reference bus is defined through the terminal of the equipment and an integer specifying the reference priority.
@@ -399,7 +399,7 @@ This extension is provided by the `com.powsybl:powsybl-iidm-api` module.
 ## Reference Terminals
 
 This extension is attached to a Network and is used to define the angle references of a Power Flow solution.
-The support of this feature by Load Flow implementations may vary. For example, the [OpenLoadFlow](../simulation/powerflow/openlf.md) implementation
+The support of this feature by Load Flow implementations may vary. For example, the [OpenLoadFlow](inv:powsyblopenloadflow:*:*#index) implementation
 today supports writing to the Network the terminals of the reference generators chosen via the [Reference Priority extension](#reference-priority).
 
 The reference bus is defined through the terminal of the equipment and an integer specifying the reference priority.

diff --git a/docs/grid_model/network_subnetwork.md b/docs/grid_model/network_subnetwork.md
@@ -287,7 +287,7 @@ A generation part, at boundary side can also be modeled with a constant active p
 
 Resulting flows at the dangling line terminal all follow the same passive-sign convention, either for the injection part or for the generation part.
 
-Dangling lines are key objects for merging networks. Merging will be described soon [here](../features/merging.md).
+Dangling lines are key objects for merging networks. Merging will be described soon [here](TODO).
 
 **Characteristics**
 
@@ -614,8 +614,8 @@ $$
 - [Discrete Measurements](extensions.md#discrete-measurements)
 - [Identifiable Short-Circuit](extensions.md#identifiable-short-circuit)
 - [Measurements](extensions.md#measurements)
-- [Two-windings Transformer Phase Angle Clock](extensions.md#two-windings-transformer-phase-angle-clock)
-- [Two-windings Transformer To Be Estimated](extensions.md#two-windings-transformer-to-be-estimated)
+- [Two-windings Transformer Phase Angle Clock](extensions.md#two-winding-transformer-phase-angle-clock)
+- [Two-windings Transformer To Be Estimated](extensions.md#two-winding-transformer-to-be-estimated)
 
 (three-winding-transformer)=
 ### Three-winding transformer
@@ -651,8 +651,8 @@ For each leg, the network bus is at side 1 and the star bus is at side 2.
 - [Discrete Measurements](extensions.md#discrete-measurements)
 - [Identifiable Short-Circuit](extensions.md#identifiable-short-circuit)
 - [Measurements](extensions.md#measurements)
-- [Three-windings Transformer Phase Angle Clock](extensions.md#three-windings-transformer-phase-angle-clock)
-- [Three-windings Transformer To Be Estimated](extensions.md#three-windings-transformer-to-be-estimated)
+- [Three-windings Transformer Phase Angle Clock](extensions.md#three-winding-transformer-phase-angle-clock)
+- [Three-windings Transformer To Be Estimated](extensions.md#three-winding-transformer-to-be-estimated)
 
 #### Three-winding transformer leg
 

diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ It is part of [LF Energy](https://www.lfenergy.org/), an open source foundation
 PowSyBl is used through Python scripts using the library [Pypowsybl](https://powsybl.readthedocs.io/projects/pypowsybl/en/stable/), but also 
 to build state-of-the-art applications.
 
-Check the [Getting started](../documentation/user/index.md) and [Configuration](../documentation/user/configuration/index.md) pages to learn how to install and configure PowSyBl.
+Check the [Getting started](./user/index.md) and [Configuration](./user/configuration/index.md) pages to learn how to install and configure PowSyBl.
 
 ```{toctree}
 ---

diff --git a/docs/simulation/dynamic/configuration.md b/docs/simulation/dynamic/configuration.md
@@ -50,7 +50,7 @@ The parameters may also be overridden with a JSON file, in which case the config
 
 ### Specific parameters
 Some implementations use specific parameters that can be defined in the configuration file or in the JSON parameters file:
-- [Dynawo](TODO)
+- [Dynawo](inv:powsybldynawo:*:*#dynamic_simulation/configuration)
 
 ### Examples
 

diff --git a/docs/simulation/dynamic/index.md b/docs/simulation/dynamic/index.md
@@ -9,7 +9,6 @@ hidden: true
 maxdepth: 1
 ---
 configuration.md
-parameters.md
 ```
 
 ## Inputs
@@ -26,17 +25,17 @@ The inputs of a dynamic simulation are the following:
 (dynamic-models-mapping)=
 ### Dynamic models mapping
 For the moment, the only way to associate dynamic models to static components is through a groovy script. Note that the syntax of this script is specific to each simulator:
-- [Dynawo dynamic model DSL](TODO)
+- [Dynawo dynamic model DSL](inv:powsybldynawo:*:*#dynamic_simulation/dynamic-models-dsl)
 
 (event-models-mapping)=
 ### Event models mapping
 For the moment, the only way to add events to the simulation is through a groovy script. Note that the syntax of this script is specific to each simulator:
-- [Dynawo event model DSL](TODO)
+- [Dynawo event model DSL](inv:powsybldynawo:*:*#dynamic_simulation/event-models-dsl)
 
 (curves-configuration)=
 ### Curves configuration
 For the moment, the only way to monitor dynamic variables of the simulation in order to export curves at the end of the simulation is to provide a groovy script to the simulation. Note that the syntax of this script is specific to each simulator:
-- [Dynawo curves DSL](TODO)
+- [Dynawo curves DSL](inv:powsybldynawo:*:*#dynamic_simulation/curves-dsl)
 
 ## Outputs
 

diff --git a/docs/simulation/dynamic_security/configuration.md b/docs/simulation/dynamic_security/configuration.md
@@ -20,7 +20,7 @@ dynamic-security-analysis:
 
 ## Parameters
 The `dynamic-security-analysis-default-parameters` module is used every time a dynamic security analysis is run. It defines the default values for the most common parameters a `com.powsybl.security.dynamic.DynamicSecurityAnalysis` implementation should be able to handle.
-In addition to its own set of parameters, the dynamic security analysis reuses [dynamic simulation parameters](../dynamic/parameters.md).
+In addition to its own set of parameters, the dynamic security analysis reuses [dynamic simulation parameters](../dynamic/configuration.md).
 
 You may configure some generic parameters for all implementations:
 ```yaml

diff --git a/docs/simulation/loadflow/configuration.md b/docs/simulation/loadflow/configuration.md
@@ -135,5 +135,5 @@ The default value is `1.0`.
 
 ### Specific parameters
 Some implementations use specific parameters that can be defined in the configuration file or in the JSON parameters file:
-- [PowSyBl OpenLoadFlow](TODO)
-- [DynaFlow](TODO)
+- [PowSyBl OpenLoadFlow](inv:powsyblopenloadflow:*:*#loadflow/parameters)
+- [DynaFlow](inv:powsybldynawo:*:*#load_flow/configuration)
diff --git a/docs/simulation/loadflow/index.md b/docs/simulation/loadflow/index.md
@@ -41,9 +41,9 @@ active power (zero MW if slack distribution is disabled).
 ## Implementations
 
 The following power flow implementations are supported:
-- [PowSyBl OpenLoadFlow](TODO)
-- [Dynaflow](TODO)
+- [PowSyBl OpenLoadFlow](inv:powsyblopenloadflow:*:*#index)
+- [Dynaflow](inv:powsybldynawo:*:*#index)
 
 ## Going further
 - [Run a power flow through an iTools command](../../user/itools/loadflow.md): Learn how to perform a power flow calculation from the command line
-- [Load flow tutorial](../../developer/tutorials/loadflow.md)
+- [Load flow tutorial](inv:powsybltutorials:*:*#loadflow)
diff --git a/docs/user/itools/index.md b/docs/user/itools/index.md
@@ -106,5 +106,5 @@ The `iTools` script relies on a [plugin mechanism](): the commands are discovere
 
 ## Going further
 The following links could also be useful:
-- [Bundle an iTools package](../../developer/tutorials/itools-packager.md): Learn how to use the `itools-packager` maven plugin
-- [Create an iTools command](../../developer/tutorials/itools-command.md): Learn how to create your own `iTools` command in Java
+- [Bundle an iTools package](inv:powsybltutorials:*:*#itools/itools-packager): Learn how to use the `itools-packager` maven plugin
+- [Create an iTools command](inv:powsybltutorials:*:*#itools/itools-command): Learn how to create your own `iTools` command in Java