Skip to content
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

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

Open
stichbury opened this issue Feb 1, 2024 · 1 comment
Open

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

stichbury opened this issue Feb 1, 2024 · 1 comment

Comments

@stichbury
Copy link

I think you'll probably be able to see this issue: kedro-org/kedro#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
Copy link
Collaborator

JWCook commented Feb 1, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants