Consider adding sphinx-gallery to the documentation section

[choldgraf]

Heya - this looks like a cool and useful project! Just wanted to raise awareness of a plugin that makes it easy to create galleries for "examples" folders and the like. It's called Sphinx-Gallery and is what a lot of scientific python projects use for their galleries (e.g. scikit-learn and matplotlib). Let me know if this would be of interest and I can make a PR!

[danielballan]

Thanks!

Yes, I would welcome that contribution. Would it be best as a separate section ("Creating an Example Gallery") presented later, as we do with "Common Patterns for Tests," or should we present it as part of the "Writing Documentation" section, incorporating it in the discussion about narrative vs API docs? I'm of two minds about it. I want to carefully avoid scaring people off by introducing too much infrastructure up front; on the other hand, it's good to give readers the full picture as early as we practically can.

[choldgraf]

I think it'd be better as a separate section (as in something where a user would need to take a separate action to see). I agree you don't wanna overload people!

[danielballan]

Good, that's my gut feeling also.

[danielballan]

In #82 we add a sentence in an appropriate place encouraging users to look at sphinx-gallery. I think adding a section on it could be valuable as well, so I will leave this open. 👍