search

melissawm / sphinx-tags

A tiny Sphinx extension that implements blog-style tags for documentation.
https://sphinx-tags.readthedocs.io/en/latest/
MIT License
44 stars 11 forks source link

Setting to enable/disable the tags page in the toctree #97

Open stichbury opened 7 months ago

stichbury commented 7 months ago

I think you'll probably be able to see this issue: https://github.com/kedro-org/kedro/issues/3576

What I'm after is a way to tag pages of our markdown docs so that we can flag up with a note on top when there are pages marked as "Probably need fixing" and "Definitely out of date" so readers can be wary of believing everything they read! I liked this extension but I don't want to put the tags summary into the toctree or create a page for each tag that links back to the pages that use the tag.

I think your extension automatically does those things and I couldn't work out how to disable it/ignore it without getting warnings of missing links if I excluded the page in conf.py.

JWCook commented 7 months ago

Your use case makes sense, but I think this extension likely isn't a good fit for what you want to do. From that linked issue it sounds like the badge styling is the main feature you want. If so, check out the sphinx-design extension, which is what sphinx-tags uses to create tag badges: https://sphinx-design.readthedocs.io/en/latest/badges_buttons.html