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

List all pages where I have this tag #66

Open clrh opened 11 months ago

clrh commented 11 months ago

Hi,

I am looking for a way to display in a page all the pages related to a tag. I cannot just "include" a _tags/TAG.md because it is relative paths and it does not work.

for example something like:

.. taglist::
   TAG

I take workaround too :)

melissawm commented 10 months ago

When a tag is detected, we create a page to list all tags, and one page per tag that lists all pages with that tag. For example,

https://sphinx-tags.readthedocs.io/en/latest/_tags/tag-documentation.html

Can you clarify why this is not sufficient in your use case? Thanks!

clrh commented 10 months ago

Yes, I use this feature. I just need to include this list in an existing page. This is a feature asked really often for documentations I organize.

clrh commented 10 months ago

Not "the page", bug only the list :)

melissawm commented 10 months ago

Got it - so this would be similar to #64

Thanks for the suggestion I will definitely consider this.

clrh commented 10 months ago

almost ? I don't search listing tags, but listing pages for a tag :) Very useful I think. Not able to develop this sorry.