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

Remove noindex for docs #1998

Merged
merged 6 commits into from
Aug 15, 2023
Merged

Remove noindex for docs #1998

merged 6 commits into from
Aug 15, 2023

Conversation

SkafteNicki
Copy link
Member

@SkafteNicki SkafteNicki commented Aug 15, 2023

What does this PR do?

Fixes #865
Currently #1916 is blocked because we currently cannot reference our own metrics in our own docs due to the use of :noindex:. I propose that we remove the :noindex: from docs. The reason it is there as far as I am aware is to not have double entries when searching for something.

This is also true. Currently with :noindex: a search for BinaryAccuracy looks like
docs2
without :noindex: it would look like:
docs1

I think it would not be too destructive to have multiple of the same search results if we compare with the benefit that we can begin to actually reference our own metrics in the docs. This change also solves the linked issue, such that others can cross-reference torchmetrics in their own documentation.

Before submitting
  • Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure to update the docs?
  • Did you write any new necessary tests?
PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃


📚 Documentation preview 📚: https://torchmetrics--1998.org.readthedocs.build/en/1998/

@SkafteNicki SkafteNicki added the documentation Improvements or additions to documentation label Aug 15, 2023
@Borda Borda added the bug / fix Something isn't working label Aug 15, 2023
@mergify mergify bot added the ready label Aug 15, 2023
@Borda Borda merged commit 23356d4 into master Aug 15, 2023
60 checks passed
@Borda Borda deleted the docs/noindex branch August 15, 2023 12:37
@Borda Borda mentioned this pull request Aug 15, 2023
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug / fix Something isn't working documentation Improvements or additions to documentation ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unable to cross-reference a metric in the sphinx doc.
2 participants