Open
Description
Execute .ipynb jupyter notebook files for the examples gallery.
This nice to have to-do item came up during development of #200
I don't see the ipython notebook example int he built html docs. I had expected to see it appear as a page in the examples gallery. @melissawm is this part working for you?
EDIT: Ah, I see now. Any jupyter notebook files are being deliberately skipped (see
setup
function indocs/conf.py
)def setup(app): """Set up docs build. * Ignores .ipynb files to prevent sphinx from complaining about multiple files found for document when generating the gallery * Rewrites github anchors to be comparable * Adds google calendar api key to meetings schedule page """ app.registry.source_suffix.pop(".ipynb", None)I thought we wanted the notebooks to be executed and included? #70
I see that there is a single line of text in the gallery.rst page linking to it, but that is easy to overlook. It also leaves us vulnerable to the code in that notebook going out of date, and we won't know it produces errors.
Nice to have, possibly in a later PR:
- I'm not sure what the reason for skipping these in the napari/docs is. There might be some tricky technical issue preventing it here too? See this line of code in conf.py.
Metadata
Metadata
Assignees
Labels
No labels