Skip to content

DOC: enable sphinx-tags and add tags to docs, tutorials, and examples#13757

Open
Aniketsy wants to merge 5 commits intomne-tools:mainfrom
Aniketsy:fix-11367
Open

DOC: enable sphinx-tags and add tags to docs, tutorials, and examples#13757
Aniketsy wants to merge 5 commits intomne-tools:mainfrom
Aniketsy:fix-11367

Conversation

@Aniketsy
Copy link
Copy Markdown
Contributor

Fixes #11367

@Aniketsy
Copy link
Copy Markdown
Contributor Author

Since this change touches many files, I will review them once more to make sure everything is correct. converting into draft.

@Aniketsy Aniketsy marked this pull request as draft March 15, 2026 18:57
@Aniketsy Aniketsy marked this pull request as ready for review April 16, 2026 18:51
@Aniketsy
Copy link
Copy Markdown
Contributor Author

@larsoner gentle-ping , please have a look in this, when you get chance . Thanks!

@larsoner
Copy link
Copy Markdown
Member

Before I look too deeply, I see +471 and most files are just +2 for added files, so we're looking at on the order of ~200 files that have tags to consider. This will be a bit of a pain to review for correctness 😅

Can you comment on how you added these contents?

I'm wondering if we should write a little utility script that automatically adds these tags to tutorials based on their nesting in tutorials and/or content ...

@drammock
Copy link
Copy Markdown
Member

I discussed this PR with @britta-wstnr a while back, and forgot to report that here.

  • We thought that probably the best approach is to decide first what a useful tag vocabulary would be, and then add each of those tags to all relevant docs pages (potentially one or a few at a time, so it would be easier to review).
  • An important consideration here is that the tags are most useful as a supplement to what you can already find with searching or browsing the site. In other words, it's not useful to tag all tutorials with a tutorial tag, since all tutorials are already listed on a single page that is easy to find by browsing.
  • I think determining the right tag lexicon is something that will take time and input from the user community, which leads me toward closing this in favor of an explicit request for ideas from the community.

@Aniketsy
Copy link
Copy Markdown
Contributor Author

Before I look too deeply, I see +471 and most files are just +2 for added files, so we're looking at on the order of ~200 files that have tags to consider. This will be a bit of a pain to review for correctness 😅

yes 😀 , these are quite lot of files,

Can you comment on how you added these contents?

Mostly i followed by reading docstring, and in some case looking into the code part of tutorial what is discussed and what comments states, i maybe not fully accurate, but my approach was like that.. :)

We thought that probably the best approach is to decide first what a useful tag vocabulary would be, and then add each of those tags to all relevant docs pages (potentially one or a few at a time, so it would be easier to review).

yes, i agree with this point as it would be easier to review.

@Aniketsy
Copy link
Copy Markdown
Contributor Author

I think determining the right tag lexicon is something that will take time and input from the user community, which leads me toward closing this in favor of an explicit request for ideas from the community.

please let me know, if i can help with any steps to reduce the review work or happy to proceed with decision ...

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

Successfully merging this pull request may close these issues.

consider using sphinx-tags

3 participants