Add/fix links to powsybl-core APIs

Signed-off-by: Florian Dupuy <[email protected]>
powsybl · Jun 26, 2024 · dee5d93 · dee5d93
1 parent b9b709e
commit dee5d93
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 9 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -128,6 +128,7 @@
 
 # Links to external documentations : python 3 and pandas
 intersphinx_mapping = {
+    "powsyblcore": ("https://powsybl.readthedocs.io/projects/powsybl-core/en/latest/", None)
 }
 intersphinx_disabled_reftypes = ["*"]
 

diff --git a/docs/dynamic_simulation/index.md b/docs/dynamic_simulation/index.md
@@ -8,7 +8,7 @@ event-models-dsl.md
 curves-dsl.md
 ```
 
-PowSyBl provides an implementation to run [dynamic simulation](inv:powsyblcore:*:*#simulation/dynamic/index) with [DynaWaltz](https://dynawo.github.io/about/dynawaltz), a tool for long-term stability simulation from the [Dynaωo](https://dynawo.github.io) suite.
+PowSyBl provides an implementation of the [DynamicSimulation API from powsybl-core](inv:powsyblcore:*:*#simulation/dynamic/index) with [DynaWaltz](https://dynawo.github.io/about/dynawaltz), a tool for long-term stability simulation from the [Dynaωo](https://dynawo.github.io) suite.
 
 ## Installation
 

diff --git a/docs/index.md b/docs/index.md
@@ -1,8 +1,8 @@
 # Powsybl-dynawo documentation
-Powsybl-dynawo is an interface between PowSyBl and [Dynaωo](https://dynawo.github.io) open source suites, providing implementations for:
-- [Load flow](./load_flow/index),
-- Security analysis,
-- [Dynamic simulation](./dynamic_simulation/index).
+Powsybl-dynawo is an interface between PowSyBl and [Dynaωo](https://dynawo.github.io) open source suites, providing:
+- an implementation of [LoadFlow API from powsybl-core](inv:powsyblcore:*:*#simulation/loadflow/index),
+- an implementation of [SecurityAnalysis API from powsybl-core](inv:powsyblcore:*:*#simulation/security/index),
+- an implementation of [DynamicSimulation API from powsybl-core](inv:powsyblcore:*:*#simulation/dynamic/index).
 
 ```{toctree}
 :hidden:

diff --git a/docs/load_flow/index.md b/docs/load_flow/index.md
@@ -5,8 +5,8 @@
 dynaflow-configuration.md
 ```
 
-PowSyBl provides an implementation to run [load flow](inv:powsyblcore:*:*#simulation/loadflow/index) with [DynaFlow](https://dynawo.github.io/about/dynaflow).
-DynaFlow is a advanced steady-state simulation tool that aims at calculating the steady-state point by using a simplified time-domain simulation, guaranteeing the correctness of the solution found.
+PowSyBl provides an implementation of the [LoadFlow API from powsybl-core](inv:powsyblcore:*:*#simulation/loadflow/index) with [DynaFlow](https://dynawo.github.io/about/dynaflow).
+DynaFlow is an advanced steady-state simulation tool that aims at calculating the steady-state point by using a simplified time-domain simulation, guaranteeing the correctness of the solution found.
 You can find more information about it [here](https://dynawo.github.io/about/dynaflow).
 
 ## Installation

diff --git a/pom.xml b/pom.xml
@@ -56,7 +56,7 @@
 
     <properties>
         <java.version>17</java.version>
-        <powsyblcore.version>6.3.0</powsyblcore.version>
+        <powsybl-core.version>6.3.0</powsybl-core.version>
         <groovy.version>4.0.14</groovy.version> <!-- used for groovy-json but also for groovydoc (dynawaltz-dsl) -->
         <sonar.coverage.jacoco.xmlReportPaths>
             ../distribution/target/site/jacoco-aggregate/jacoco.xml,
@@ -107,7 +107,7 @@
             <dependency>
                 <groupId>com.powsybl</groupId>
                 <artifactId>powsybl-core</artifactId>
-                <version>${powsyblcore.version}</version>
+                <version>${powsybl-core.version}</version>
                 <type>pom</type>
                 <scope>import</scope>
             </dependency>