diff --git a/docs/conf.py b/docs/conf.py index a5f1ccfc9..ae2b0725f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -63,8 +63,8 @@ # html_theme = "furo" -html_title = 'dynawo' -html_short_title = 'dynawo' +html_title = 'powsybl-dynawo' +html_short_title = 'powsybl-dynawo' html_logo = '_static/logos/logo_lfe_powsybl.svg' html_favicon = "_static/favicon.ico" diff --git a/docs/dynamic_simulation/dynamic-models-dsl.md b/docs/dynamic_simulation/dynamic-models-dsl.md index 9eeb0d8b2..bb481b40e 100644 --- a/docs/dynamic_simulation/dynamic-models-dsl.md +++ b/docs/dynamic_simulation/dynamic-models-dsl.md @@ -7,9 +7,6 @@ layout: default The Dynamic Models DSL is a domain specific language written in groovy for the creation dynamic models used by Dynawo, most of them associated with a static equipment present in the network. If some equipments are not configured, Dynawo would use a default model and set of parameters. -* TOC -{:toc} - ## BlackBoxModel All the models supported are `BlackBoxModel`. This kind of dynamic model have three attributes: - `lib` refers to the dynamic model library used in Dynawo. @@ -53,7 +50,8 @@ OverloadManagementSystem { iMeasurementSide TwoSides.TWO } ``` -TODO: add all automation systems + +#### TODO add all automation systems ## Supported models Models are listed in [models.json](../../blob/main/dynawaltz/src/main/resources/models.json). diff --git a/docs/dynamic_simulation/event-models-dsl.md b/docs/dynamic_simulation/event-models-dsl.md index 4ef9413ab..a411f26ba 100644 --- a/docs/dynamic_simulation/event-models-dsl.md +++ b/docs/dynamic_simulation/event-models-dsl.md @@ -6,9 +6,6 @@ layout: default The Event Models DSL is a domain specific language written in groovy for the simulation of events that occurs during the simulation. -* TOC -{:toc} - ## Event Model - All the models supported are `BlackBoxModel`. This kind of event model have three attributes: - `lib` refers to the event model library used in Dynawo. @@ -26,5 +23,4 @@ Disconnect { } ``` -TODO add events -``` +#### TODO add remaining events diff --git a/docs/index.md b/docs/index.md index 7e37ca609..2cba74964 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,10 @@ +# Powsybl-dynawo documentation +Powsybl-dynawo is an interface between the PowSyBl project and [Dynawo](https://dynawo.github.io) providing Load Flow, Security Analysis and Dynamic Simulation implementations. + ```{toctree} --- -caption: Contents of this website maxdepth: 2 -hidden: true --- dynamic_simulation/index.md ``` - -# TODO \ No newline at end of file