Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add readthedocs configuration files and first pages #607

Merged
merged 14 commits into from
Jun 19, 2024
Merged

Conversation

So-Fras
Copy link
Member

@So-Fras So-Fras commented Apr 19, 2024

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Docs have been added / updated (for bug fixes / features)

What kind of change does this PR introduce?
Add readthedocs configuration files and a few example pages.

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

  • Yes
  • No

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>
@So-Fras So-Fras added the documentation Improvements or additions to documentation label Apr 19, 2024
@So-Fras So-Fras self-assigned this Apr 19, 2024
Copy link

sonarcloud bot commented Apr 22, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

So-Fras and others added 3 commits May 28, 2024 15:40
Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>
Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>
docs/index.md Outdated Show resolved Hide resolved
docs/network_area_diagrams/api/api.md Outdated Show resolved Hide resolved
docs/single_line_diagrams/api/api.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>
@So-Fras So-Fras requested a review from flo-dup May 31, 2024 09:28
So-Fras and others added 6 commits June 10, 2024 16:47
Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>
Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>
Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>
Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>
…itories)

Signed-off-by: Sophie Frasnedo <sophie.frasnedo@rte-france.com>
docs/network_area_diagrams/index.md Show resolved Hide resolved
docs/network_area_diagrams/index.md Show resolved Hide resolved
docs/network_area_diagrams/index.md Outdated Show resolved Hide resolved
docs/single_line_diagrams/index.md Outdated Show resolved Hide resolved
@@ -0,0 +1,18 @@
![PowSyBl Logo](_static/logos/logo_lfe_powsybl.svg)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it a bit oppressive this big colourful logo! 😄 but the main problem is to have something uniform across the repositories. We should have the same kind of home page for all of them, and so far some are including it, some not

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, there is a work to be done on standardization. But, as you said, since some repositories have it and some haven't, we need to discuss this point with other maintainers.

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

sonarcloud bot commented Jun 19, 2024

@flo-dup flo-dup merged commit 2ef39d6 into main Jun 19, 2024
7 checks passed
@flo-dup flo-dup deleted the add_readthedocs branch June 19, 2024 08:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation PR: next-release
Projects
Development

Successfully merging this pull request may close these issues.

2 participants