We welcome anyone interested in contributing to this project, be it with new ideas, suggestions, by filing bug reports or contributing code.
You are invited to submit pull requests / issues to our Github repository.
For linting, formatting and checking your code contributions against our guidelines (e.g. we use Black as code style and use pre-commit:
conda install -c conda-forge pre-commitor
pip install pre-commit
To automatically activate
git commit: Run
To manually run it:
pre-commit run --all
Nice examples are always welcome.
You can even submit your Jupyter notebook (
as an example.
For contributing notebooks (and working with notebooks in git
in general) we have compiled a workflow for you which we suggest
Locally install this precommit hook for git
This obviously has to be done only once. The hook checks if any of the notebooks you are including in a commit contain a non-empty output cells.
Then for every notebook:
Write the notebook (let’s call it
foo.ipynb) and place it in
Ask yourself: Is the output in each of the notebook’s cells relevant for to example?
Yes: Leave it there. Just make sure to keep the amount of pictures/… to a minimum.
No: Clear the output of all cells, e.g. Edit -> Clear all output in JupyterLab.
Provide a link to the documentation: Include a file
doc/examples/foo.nblinkwith this content
Link your file in the documentation:
examples/foo.nblinkdirectly into one of the documentations toctrees; or
Tell us where in the documentation you want your example to show up
Commit your changes. If the precommit hook you installed above kicks in, confirm your decision (‘y’) or go back (‘n’) and delete the output of the notebook’s cells.
Create a pull request for us to accept your example.
The support for the the
.ipynb notebook format in our documentation
is realised via the extensions nbsphinx and nbsphinx_link.