{{ message }}
Repository navigation
Provide links to API docs in examples #2222
Description
It would be very useful to provide links to matplotlib API docs for methods/objects/etc.. used in examples. This could be a part of MEP12.
An intuitive approach could be to automatically render links in displayed code. If that sort of thing is not already in Sphynx, I guess I'm suggesting a sphynx extension (and should go over there to suggest it ;)
Some (not so good) alternatives could be to associate links to API docs with certain tags or to include a few hand-coded links in each example page. Not so good as it would be incomplete (many methods/... used would not be linked) and would lead to inconsistencies (some examples much better linked than others).
Activity
drevicko commentedon Jul 17, 2013
Likewise, links from the API docs to examples containing/using the said method/object etc.. would be useful.
pelson commentedon Aug 12, 2013
I'd love to see this. Sounds like some hard work, but it'd be well worth it IMHO.
petehuang commentedon Dec 29, 2016
This would still be useful, and a Sphinx extension would be nice, but wondering if it would ever get done. Could turn this into a larger doc project.
tacaswell commentedon Dec 29, 2016
@NelleV is this something sphinx-gallery can already do?
dopplershift commentedon Dec 29, 2016
Yes, though in brief attempts I've not made it work for my own stuff. See for example:
https://sphinx-gallery.readthedocs.io/en/latest/auto_examples/plot_exp.html#sphx-glr-auto-examples-plot-exp-py
tacaswell commentedon Dec 29, 2016
Tagged as new-contributor friendly as this is self-contained from the rest of the library, but hard as it involves learning how to write / modify sphinx extensions
NelleV commentedon Dec 30, 2016
Yes, that feature is in sphinx-gallery
NelleV commentedon Dec 30, 2016
@tacaswell is the ticket to migrate to sphinx gallery or to reimplement the feature ? If it is to migrate to sphinx-gallery, we already have a ticket opened.
petehuang commentedon Dec 30, 2016
@NelleV Wow this is cool!
I believe this is to migrate
choldgraf commentedon Jul 15, 2017
This issue is now taken care of with the migration to sphinx-gallery. There are still some kinks to work out, but the general functionality is there and should be spot-checked with subsequent issues / PRs. I think we should close this
WeatherGod commentedon Jul 15, 2017
Agreed, closing.