Closed
Description
The example gallery now has 17 items and might benefit from being organized into sections. This has been briefly discussed elsewhere:
- Add gallery example for cross-axis slope backtracking #1077 (comment)
- Mount gallery examples #1266 (comment)
I think the sphinx configuration changes to do this would be straightforward (see here). The question is how the gallery should be organized. For inspiration, here are some other packages with sections in their gallery:
- matplotlib: https://matplotlib.org/stable/gallery/index.html
- metpy: https://unidata.github.io/MetPy/latest/examples/index.html
- sunpy: https://docs.sunpy.org/en/stable/generated/gallery/index.html
- cartopy: https://scitools.org.uk/cartopy/docs/latest/gallery/index.html
- scikit-learn: https://scikit-learn.org/stable/auto_examples/index.html
- probably other ones listed here: https://sphinx-gallery.github.io/stable/projects_list.html
To get the conversation started, here are some categorizations mentioned in the above threads:
- by abstraction level: functions vs objects
- by task (or "how do I"), e.g. system modeling vs resource assessment vs ...
- by modeling topic, roughly along the lines of the pvlib module breakdown and PVPMC diagram
Input from anyone is welcome!