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 documentation #10

Merged
merged 8 commits into from
Jun 11, 2024
Merged

Add readthedocs documentation #10

merged 8 commits into from
Jun 11, 2024

Conversation

flo-dup
Copy link
Contributor

@flo-dup flo-dup commented May 30, 2024

Please check if the PR fulfills these requirements

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

Does this PR already have an issue describing the problem?
No

What kind of change does this PR introduce?
Docs update

What is the current behavior?
No documentation except README.md

What is the new behavior (if this is a feature change)?
Readthedocs documentation in /docs, leading to a new http://pypowsybl-jupyter.readthedocs.io website

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

  • Yes
  • No

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>
Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>
@flo-dup
Copy link
Contributor Author

flo-dup commented May 30, 2024

Copyright still needs to be corrected like in powsybl/powsybl-core#3035

CBiasuzzi added 4 commits May 31, 2024 19:22
Signed-off-by: Christian Biasuzzi <christian.biasuzzi@soft.it>
Signed-off-by: Christian Biasuzzi <christian.biasuzzi@soft.it>
Signed-off-by: Christian Biasuzzi <christian.biasuzzi@soft.it>
…the current release from pyproject.toml

Signed-off-by: Christian Biasuzzi <christian.biasuzzi@soft.it>
@CBiasuzzi
Copy link
Contributor

in the end, I left in the footer "PowSyBl documentation", which is the same name used in powsybl-core docs' footer
(but the actual link points to the correct powsybl-jupyter repo).

Copyright © 2024 Authors of PowSyBl documentation

The alternative was differentiating with:
Copyright © 2024 Authors of pypowsybl-jupyter documentation

Is it OK to consider "Author PowSyBl documentation" as a generic term for the collective writing docs for the PowSyBl projects, right?

CBiasuzzi added 2 commits June 7, 2024 17:37
Signed-off-by: Christian Biasuzzi <christian.biasuzzi@soft.it>
Copy link
Contributor Author

@flo-dup flo-dup left a comment

Choose a reason for hiding this comment

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

I agree with your changes @CBiasuzzi! but I cannot approve as I opened the PR. Could you do it?

@CBiasuzzi CBiasuzzi self-requested a review June 11, 2024 15:20
@flo-dup flo-dup merged commit 7476e6c into main Jun 11, 2024
4 checks passed
@flo-dup flo-dup deleted the add_rtfd branch June 11, 2024 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants