-
Notifications
You must be signed in to change notification settings - Fork 207
Support Tagging examples #261
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
Could you elaborate on the idea. I'm not sure what you are asking nor I understand from the issue in sunpy.
|
In some sense #205 could be made to take care of this using backreferences. |
@Titan-C can you elaborate a bit on the tagging? For example, I'd love to push for tags to be integrated into https://matplotlib.org/gallery/ in a way that the tags can be searched & all examples w/ a given tag surfaced. |
@story645 did you look at the first suggestion? You can use either of these solutions to tag/index examples just by adding RST to the example text somewhere (probably beneath the description paragraph? Or maybe right under the title if we properly support ignoring |
I did, but I'm not sure how to go from that to on the fly galleries of examples w/ the same tag. |
@story645 Is the index answer (https://stackoverflow.com/a/19837140) a reasonable solution for you? |
Hi folks - I have created a small Sphinx extension to do this. Feel free to give feedback or ask for features. Thanks! |
Awesome, thanks @melissawm ! FWIW if you'd rather have that repo live under an org account at some point rather than your personal one, I'm happy to help move that repo over to sphinx-gallery's org if you think it's a good fit, and give you appropriate permissions, etc. Closing as fixed by sphinx-tags extension rather than SG |
@larsoner about that 😄 I just cut a release that I think makes sphinx-tags usable: https://github.com/melissawm/sphinx-tags If you think this fits sphinx-gallery I'm happy to move - it would give the project more visibility and I'd love to help support sphinx-gallery, too. Cheers! |
@lucyleeow WDYT? |
Sounds great to me! I would maybe just suggest to make it clear that the tags work on all documentation pages, not just gallery examples? |
It would be nice to be able to have some kind of categories that examples in multiple sections could be assigned to (i.e. all these examples use one subpackage).
sunpy/sunpy#2164
The text was updated successfully, but these errors were encountered: