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 notebooks to docs #88

Open
7yl4r opened this issue Sep 5, 2022 · 1 comment
Open

add notebooks to docs #88

7yl4r opened this issue Sep 5, 2022 · 1 comment

Comments

@7yl4r
Copy link
Collaborator

7yl4r commented Sep 5, 2022

Is there a way to include the jupyter notebooks in the docs? A rendered output would be nice, but a list of links & short descriptions would be good too.

@ocefpaf
Copy link
Collaborator

ocefpaf commented Sep 5, 2022

This is how I do it but I believe there are easier ways out there:

  1. add nbsphinx to the dev requirements
  2. have a directory with the notebooks outside of the docs
  3. in the CI that builds the docs I run the notebooks with nbconverter and move them into the docs/source directory
  4. list them in the index.rst file so sphinx can find them

The reason why I keep the notebooks in a separate folder is so we can commit them without the outputs for cleaner diffs and slimmer repos. Also, the nbconvert step becomes a test for them, if the notebooks fails to run the doc build will fail.

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

2 participants