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

Test doc generation with read the docs #903

Merged
merged 23 commits into from
Mar 21, 2024
Merged

Test doc generation with read the docs #903

merged 23 commits into from
Mar 21, 2024

Conversation

pet-mit
Copy link
Collaborator

@pet-mit pet-mit commented Feb 26, 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)

What kind of change does this PR introduce?

Feature

What is the current behavior?

Documentation is published using code here: https://github.com/farao-community/farao-community.github.io
This makes the doc hard to maintain + no versionning supported.
In this first PR, only CRAC doc is migrated ; other PRs should follow to migrate the rest.

What is the new behavior (if this is a feature change)?
In this PR, the documentation would be published on "readthedocs"
This makes it easier to maintain and keep up-to-date, since we can update it in the same PR as in feature developments.

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

  • Yes
  • No

Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
Signed-off-by: Peter Mitri <[email protected]>
@pet-mit pet-mit marked this pull request as ready for review March 21, 2024 15:36
@pet-mit pet-mit merged commit dc419d2 into main Mar 21, 2024
6 checks passed
@pet-mit pet-mit deleted the init_readthedocs branch March 21, 2024 16:56
jipea pushed a commit that referenced this pull request Apr 2, 2024
MartinBelthle pushed a commit that referenced this pull request May 28, 2024
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