Migration to readthedocs #85

So-Fras · 2024-11-27T22:21:51Z

Please check if the PR fulfills these requirements

The commit message follows our guidelines

What kind of change does this PR introduce?
Documentation migration to readthedocs

Does this PR introduce a breaking change or deprecate an API?

Yes
No

Other information:

Delete readme and associated images when readthedocs is complete.
A PR in the .github repo should also be opened to mention the new readthedocs in the https://powsybl.readthedocs.io/en/latest/ page --> Add optimizer to the list of Simulators .github#73

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>

p-arvy

Thank you for all your work, @So-Fras!
Just minor comments related to improving the LaTeX formatting.

docs/optimizer/acOptimalPowerflow.md

docs/optimizer/preprocessing.md

Co-authored-by: p-arvy <126792538+p-arvy@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

colinepiloquet

Pretty nice documentation! I like the part that explains how to make references to other pages from other read the docs. I mostly found a few words to modify but it's not that troublesome.

docs/optimizer/acOptimalPowerflow.md

docs/optimizer/dcOptimalPowerflow.md

docs/optimizer/divisionOfCode.md

docs/optimizer/outputs.md

docs/optimizer/slackBusMainConnexComponent.md

Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>

…optimizer into add_readthedocs Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

sonarqubecloud · 2024-12-05T08:44:35Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

So-Fras added 3 commits November 27, 2024 23:18

First addition of readthedocs

05eb798

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>

Fix links

6377365

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>

Small fixes

a022b28

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>

So-Fras changed the title ~~[WIP] Migration to readthedocs~~ Migration to readthedocs Dec 3, 2024

Remove documentation from open-reac README

05de7e1

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>

So-Fras mentioned this pull request Dec 3, 2024

Add optimizer to the list of Simulators powsybl/.github#73

Merged

3 tasks

So-Fras marked this pull request as ready for review December 3, 2024 12:16

So-Fras requested review from klorel, colinepiloquet and p-arvy December 3, 2024 12:17

So-Fras self-assigned this Dec 3, 2024

p-arvy reviewed Dec 3, 2024

View reviewed changes

docs/optimizer/acOptimalPowerflow.md Outdated Show resolved Hide resolved

docs/optimizer/acOptimalPowerflow.md Outdated Show resolved Hide resolved

docs/optimizer/acOptimalPowerflow.md Outdated Show resolved Hide resolved

docs/optimizer/preprocessing.md Outdated Show resolved Hide resolved

So-Fras and others added 4 commits December 3, 2024 17:04

Update docs/optimizer/acOptimalPowerflow.md

dabf520

Co-authored-by: p-arvy <126792538+p-arvy@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

Update docs/optimizer/acOptimalPowerflow.md

8dfa8e2

Co-authored-by: p-arvy <126792538+p-arvy@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

Update docs/optimizer/acOptimalPowerflow.md

b9c5edc

Co-authored-by: p-arvy <126792538+p-arvy@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

Update docs/optimizer/preprocessing.md

214da48

Co-authored-by: p-arvy <126792538+p-arvy@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

p-arvy approved these changes Dec 3, 2024

View reviewed changes

colinepiloquet reviewed Dec 4, 2024

View reviewed changes

So-Fras and others added 6 commits December 5, 2024 09:32

Update docs/optimizer/acOptimalPowerflow.md

6d6116d

Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

Update docs/optimizer/divisionOfCode.md

5c04da4

Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

Update docs/optimizer/outputs.md

972869b

Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

Update docs/optimizer/slackBusMainConnexComponent.md

d0f8e20

Co-authored-by: Coline Piloquet <55250145+colinepiloquet@users.noreply.github.com> Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

Fix typos

c751b14

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>

Merge branch 'add_readthedocs' of https://github.com/powsybl/powsybl-…

4f33628

…optimizer into add_readthedocs Signed-off-by: Sophie Frasnedo <93923177+So-Fras@users.noreply.github.com>

So-Fras merged commit 07ea633 into main Dec 5, 2024
7 checks passed

So-Fras deleted the add_readthedocs branch December 5, 2024 09:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migration to readthedocs #85

Migration to readthedocs #85

So-Fras commented Nov 27, 2024 •

edited

Loading

p-arvy left a comment

colinepiloquet left a comment

sonarqubecloud bot commented Dec 5, 2024

Migration to readthedocs #85

Migration to readthedocs #85

Conversation

So-Fras commented Nov 27, 2024 • edited Loading

p-arvy left a comment

Choose a reason for hiding this comment

colinepiloquet left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Dec 5, 2024

Quality Gate passed

So-Fras commented Nov 27, 2024 •

edited

Loading