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

Docs: Updates docs when the Jupyter Notebooks are modified (automatically) #1082

Closed
EwoutH opened this issue Nov 28, 2021 · 2 comments
Closed

Comments

@EwoutH
Copy link
Member

EwoutH commented Nov 28, 2021

Currently, when Jupyter Notebooks (.ipynb) files are updated, the documentation isn't, because it's generated from the reStructuredText (.rst) files.

In #1078, for example, intro_tutorial.ipynb is updated but intro_tutorial.rst isn't, so the Introductory Tutorial is still badly formatted.

Two potential solutions for this:

  • When an Jupyter Notebook is modified, regenerate the reStructuredText (ideally automated in CI)
  • Generate the docs directly from the Jupyter Notebooks (maybe using nbsphinx?)
@EwoutH
Copy link
Member Author

EwoutH commented Nov 14, 2022

#1420 might help developing this.

@rht
Copy link
Contributor

rht commented Jul 5, 2023

Solved by only committing the .ipynb. The doc is generated via nbsphinx. See #1694.

@rht rht closed this as completed Jul 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants