Adding an example Jupyter notebook#
First off: thank you for considering a contribution to diffeqzoo’s examples.
The more examples we have, the better! Here is how to add a notebook.
Create the .ipynb file in
docs/source/example_notebooksand fill it with contentSync the notebook to a markdown file via jupytext. Check out these instructions. This is useful to keep the git diff clean and legible.
Make sure the
exampledependencies insetup.cfgare sufficient. We try to keep the optional dependencies small, but are not as strict with theexampledependencies as with the remaining ones.Add the notebook to
docs/source/index.rst. If you skip this step, the notebook will not be rendered in the docs.Add the .ipynb file to the .gitignore and to the
cleanjob in the makefile. Do this after syncing it to a markdown version.Check that everything passes the quality checks via
make format example doc lint.Make a pull request with your changes.