Inspiration from new gallery package for sphinx: sphinx-exhibit

[choldgraf]

hey folks - I just found out about an interesting project that @anntzer from the Matplotlib community is working on. It's called "sphinx-exhibit" and replicates many of the things that sphinx-gallery does with a few improvements:

https://github.com/anntzer/sphinx-exhibit

The main differences to me seem to be:

1. sphinx-exhibit does more introspection of the code to generate intersphinx links for methods etc, similar to what @larsoner was working on in a recent PR (don't remember which one).
2. sphinx-exhibit exposes some sphinx directives so you can embed a gallery of specific examples files.

Anyway, worth keeping an eye on the project! Maybe the build process of sphinx-exhibit is different enough that it isn't possible to mimic in sphinx-gallery, but worth checking nonetheless!

[anntzer]

See matplotlib/matplotlib#11936 for some examples of the difference in generated docs and matplotlib/matplotlib#11936 (comment) for the "why" of sphinx-exhibit.

[GaelVaroquaux]

Post processing sphinx output for the notebooks is something that I had been thinking about for a while. It seems very useful. Of course the deeper inspection for better linking is useful and great! ⁣Sent from my phone. Please forgive typos and briefness.​

…

On Aug 26, 2018, 16:50, at 16:50, Antony Lee ***@***.***> wrote: See matplotlib/matplotlib#11936 for some examples of the difference in generated docs and matplotlib/matplotlib#11936 (comment) for the "why" of sphinx-exhibit. -- You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub: #402 (comment)

[GaelVaroquaux]

@larsoner : what is the reference to your PR that does deeper inspection?

[larsoner]

Mine merely parsed the docs for refs and added them. But in theory something similar could be used on objects themselves: #347

[choldgraf]

It sounds like @anntzer has already figured out much of the machinery for this, it's mostly a matter of adapting it to how sphinx-gallery builds things. However I'm not sure how incompatible the approaches of the two projects are.