Description
The documentation examples gallery relies on nbgallery to create a gallery of jupyter notebooks.
Lines 1 to 14 in d6f9019
Whenever I run one of these notebooks locally in VS Code, the results show up in the diff as changes one might want to commit to a PR. I think it might be better to switch to a different gallery without the hassle of discarding the results every time. sphinx-gallery is a better option in my opinion.
The goal of this issue is to
- add
sphinx-galleryconfiguration settings todocs/conf.py - port the
.pnybexamples indocs/galleryasexample_some_name.pyfiles. The non-code lines can be converted toreSTformat.
One main advantage of this is that it is easy to make changes to the code locally without the results showing up in the diff as files we might want to commit. Plus, it is easy to download a jupyter notebook version of an example if the user desires to do so. See the right column of this example.
Note that it might be better to work on this issue after #592 is merged.