msbentsen / plotannot Goto Github PK

Hi,

very nice package! What do you think about adding the example notebook to the docs? You could either break it up into python files and use sphinx-gallery (setup example here) or you can actually directly include the notebook in the docs using either nbsphinx or with myst-nb.

I think the second option is probably a bit easier. Example here: https://github.com/ianhi/mpl-interactions/blob/9c48292d5c5931cd136da25961729858b7846abb/docs/conf.py#L70 will then render the notebooks in this directory as pages: https://github.com/ianhi/mpl-interactions/tree/main/docs/examples