Thanks for thinking of a way to help improve this library! Remember that contributions come in all shapes and sizes beyond writing bug fixes. Contributing to documentation, opening new issues for bugs, asking for clarification on things you find unclear, and requesting new features, are all super valuable contributions.
git clone <your fork> cd mpl-interactions conda env create conda activate mpl-interactions pre-commit install
conda env create command installs all Python packages that are useful when working on the source code of
mpl_interactions and its documentation. You can also install these packages separately:
pip install -e ".[dev]"
Seeing your changes#
If you are working in a Jupyter Notebook, then in order to see your code changes you will need to either:
Restart the Kernel every time you make a change to the code.
Make the function reload from the source file every time you run it by using autoreload, e.g.:
%load_ext autoreload %autoreload 2 from mpl_interactions import ....
Working with Git#
Also feel free to ask for help/advice on the relevant GitHub issue.
Examples are best written as Jupyter notebooks. To write a new example, create in a notebook in the
docs/examples directory and list its path under one of the
toctrees in the
index.md file. When the docs are generated, they will be rendered as static html pages by myst-nb.
If you have installed all developer dependencies (see above), you can view recent modifications to the source files the following simple tox command:
tox -e doc
If you open the
index.html file in your browser you should now be able to see the rendered documentation.
Alternatively, you can use sphinx-autobuild to continuously watch source files for changes and rebuild the documentation for you. Sphinx-autobuild will be installed automatically by the above
pip command, so all you need to do is run:
tox -e doclive
In a few seconds your web browser should open up the documentation. Now whenever you save a file the documentation will automatically regenerate and the webpage will refresh for you!
Unfortunately, interactive plots are not interactive on Read the Docs, because widgets require an active Python kernel to work. Instead, we therefore shoot gif or apng screencasts of interacting with the plots and embed them in the Jupyter notebooks.
To accomplish, these GIFs are best stored in
docs/_static/images. Then, below the input cell of which you want to render cell output, you create a Markdown cell below that code cell and insert the GIF there as an image.