X Tutup
Skip to content

DOC: Convert CompareFlights example notebooks to .rst files#576

Merged
Gui-FernandesBR merged 4 commits intodevelopfrom
doc/change-compare-flights-notebooks-to-rst
Mar 18, 2024
Merged

DOC: Convert CompareFlights example notebooks to .rst files#576
Gui-FernandesBR merged 4 commits intodevelopfrom
doc/change-compare-flights-notebooks-to-rst

Conversation

@Gui-FernandesBR
Copy link
Member

Pull request type

  • ReadMe, Docs and GitHub updates

Checklist

  • Tests for the changes have been added (not needed)
  • Docs have been reviewed and added / updated
  • Lint (black rocketpy/ tests/) has passed locally
  • All tests (pytest tests -m slow --runslow) have passed locally
  • CHANGELOG.md has been updated (if relevant)

Current behavior

The example notebooks are not executed when building the documentation.
There's no way to add custom widgets (i.e. "seealso", "important", etc.)

New behavior

Two .ipynb files were converted to .rst files.
Sphinx will now execute the code cells whenever we build the docs.

  • It prevents our documentation to stay outdated.
  • This increases building time a little, but the result is worth it imo.

Breaking change

  • No

Additional information

  • Please check the read the docs, if possible.

@Gui-FernandesBR Gui-FernandesBR requested a review from a team as a code owner March 12, 2024 14:42
@Gui-FernandesBR Gui-FernandesBR added the Docs Docs and examples related label Mar 12, 2024
@Gui-FernandesBR
Copy link
Member Author

This contributes to the #532 ,

I decided to make this conversion after running the examples in PR #568

@Gui-FernandesBR Gui-FernandesBR added this to the Release v1.X.0 milestone Mar 12, 2024
Copy link
Member

@MateusStano MateusStano left a comment

Choose a reason for hiding this comment

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

LGTM! I've built the docs on readthedocs and everything seems to be fine.
I left a few suggestions but they are not a big deal

@Gui-FernandesBR Gui-FernandesBR merged commit 67af0ba into develop Mar 18, 2024
@Gui-FernandesBR Gui-FernandesBR deleted the doc/change-compare-flights-notebooks-to-rst branch March 18, 2024 18:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Docs Docs and examples related

Projects

No open projects
Status: Closed

Development

Successfully merging this pull request may close these issues.

2 participants

X Tutup