Render code examples automatically with sphinx_gallery
#2 670 ouverte le 14 oct. 2020
Métriques du dépôt
- Stars
- (8 211 étoiles)
- Métriques de merge PR
- (Merge moyen 10j 19h) (1 PR mergée en 30 j)
Description
Currently our non-notebook examples are manually included in the examples webpage via custom .rst files in tutorial/source/. As the number of examples increases, it would be better to follow NumPyro's approach and generate HTML pages automatically with sphinx_gallery. This would make examples easier to find and read, improve the design of the tutorial page, and declutter our tutorial folder on GitHub. Many of the examples also contain extensive docstrings and comments that sphinx_gallery could automatically render in HTML.
More ambitiously, we might even aim to use sphinx_gallery to include tutorials in ReadTheDocs, simplifying our release process and removing the lag between new tutorials being added on GitHub and becoming visible on the examples web page.