Projects that use this extension

[melissawm]

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!

[melissawm]

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

[mikofski]

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

[melissawm]

Let me know if you need help setting it up!

[mikofski]

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]

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

[AlexTheLion123]

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

[JWCook]

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)

[melissawm]

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

[speth]

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.

[melissawm]

Awesome, thanks for the heads up! 🎉

[DimitarGGeorgiev]

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:

[

](url)

If I comment extension, build is complete.

Thank you in advance!

[melissawm]

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]

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]

Hello again.

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

Thanks a lot for support!

Regards,
Dimitar

[fervand1]

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

[fervand1]

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

[bjlittle]

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! 🍻