Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Projects that use this extension #32

Oct 29, 2022 · 10 comments · 9 replies
Discussion options

Hi folks!

In an effort to better understand the demand for improvements, please add a note below with the name and repo for projects that are using sphinx-tags for documentation.

Cheers!

You must be logged in to vote

Replies: 10 comments · 9 replies

Comment options

melissawm
Oct 29, 2022
Maintainer Author

sphinx-tags is used for the gallery examples in napari.org

Repo: https://github.com/napari/docs

Usage: https://github.com/napari/docs/blob/48443c792b466dff0a47b22317c2e58ce3eba04f/docs/conf.py#L66

You must be logged in to vote
0 replies
Comment options

Hi @melissawm , DISCOVER Cookbook is testing out sphinx-tags in PR60

You must be logged in to vote
3 replies
@melissawm
Comment options

melissawm Feb 7, 2023
Maintainer Author

Let me know if you need help setting it up!

@mikofski
Comment options

Sorry if this is in the docs, but can I use tags above any section label, or is it only per page? Also, Sphinx-Design didn't work easily for me in JBook, but it's no big deal. Thanks!

@melissawm
Comment options

melissawm Feb 7, 2023
Maintainer Author

It is only per-page now, but I will create an issue for that just in case. Thanks!

Comment options

Trading Strategy docs are currently using sphinx-tags directly in their jupyter notebooks

You must be logged in to vote
0 replies
Comment options

I'm using this for a small personal website / possible future blog. There's not much content, just playing around to get a feel for how well Sphinx+MyST is suited for making this kind of site.

Site: https://jwcook.tilde.team
Source: https://tildegit.org/jwcook/jwcook.tilde.team (sphinx-tags config here)

You must be logged in to vote
1 reply
@melissawm
Comment options

melissawm Jul 11, 2023
Maintainer Author

Let me know if you have suggestions or feature requests! Cheers 😄

Comment options

I am testing sphinx-tags for use in an update to Cantera's example gallery, as we transition to using sphinx-gallery. Currently, I have a PR open here: Cantera/cantera#1621.

I found this via some discussion on the sphinx-gallery repo, and was very excited. I had gone through the process of tagging all of our examples a couple of years ago, with the idea of eventually using them for navigation, but never got around to writing something myself.

You must be logged in to vote
1 reply
@melissawm
Comment options

melissawm Oct 6, 2023
Maintainer Author

Awesome, thanks for the heads up! 🎉

Comment options

Hello,

I install extension the way described in:

https://sphinx-tags.readthedocs.io/en/latest/quickstart.html#installation

When I perform build, I recive error:

[
build
extensions
tag-install
error-message
list

](url)

If I comment extension, build is complete.

Thank you in advance!

You must be logged in to vote
3 replies
@melissawm
Comment options

melissawm Nov 7, 2023
Maintainer Author

Hi - this is probably best moved to a support topic, but did you add sphinx-tags as a requirement on your requirements.txt or environment.yml file?

@DimitarGGeorgiev
Comment options

Thank you for advance. I am new in sphinx language programming. Please, can you tell me how is correct to add extension: "sphinx-tags" or "sphinx_tags"?

@DimitarGGeorgiev
Comment options

Hello again.

I add sphinx-tags as a requirement in requirements.txt and now build is complete!

Thanks a lot for support!

Regards,
Dimitar

Comment options

Hi @melissawm thanks for having this extension. I am trying use sphinx tags in my documentation and It works fine.

But I had a issue with sphinx-autobuild which I raised but not sure if it is a known issue or there is a config to overcome it, couldn't find it in the documentation.
Also is it possible to have tags as batches but with links? or it will be feature request? I was looking at sphinx panels here https://sphinx-panels.readthedocs.io/en/latest/ and something like linked badges could be a interesting feature to have. Thanks again

You must be logged in to vote
1 reply
@fervand1
Comment options

Ignore my comment about hyperlinked badges, I see it working now but the the autobuild issue remains
image

Comment options

Hey @melissawm,

Thanks for sphinx-tags it's really great!

Just thought that I'd let you know that I've started to use sphinx-tags over on geovista 🥳

Lookin' forward to the proposed issue enhancements for the next release.

Cheers! 🍻

You must be logged in to vote
0 replies
Comment options

Thanks for this nice extension! @rekomodo and I are using on FESTIM 🚀

We made an online Verification & Validation book 📖

You must be logged in to vote
0 replies
Comment options

Hi @melissawm,

Thanks for this awesome sphinx extention!

I'd let you know that We've started to use sphinx-tags over on pyvista 🚀

pyvista/pyvista#6375

Special thanks for @adeak for review and @story645 for ideas

You must be logged in to vote
0 replies
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
10 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.