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

DOC: convert notebooks to .rst files in the documentation #532

Open
2 tasks
Gui-FernandesBR opened this issue Jan 14, 2024 · 0 comments
Open
2 tasks

DOC: convert notebooks to .rst files in the documentation #532

Gui-FernandesBR opened this issue Jan 14, 2024 · 0 comments
Labels
Docs Docs and examples related

Comments

@Gui-FernandesBR
Copy link
Member

Is your feature request related to a problem? Please describe.

We have been using jupyter notebooks to create documentation pages for rocketpy since many years ago.
A more modern way to do that is keeping .rst files, which are more customizable and allow for a better visualization in general.

Describe the solution you'd like

  • In the docs folder, convert the .ipynb to .rst (see nbconvert)
  • OPTIONAL: create a folder with "dev" scripts to be used for developers when trying to test new features.

Additional context

Be careful if you set all the simulations to be run during the docs building process, that could slow down the whole thing excessively.

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
Status: Backlog
Development

No branches or pull requests

1 participant