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

docs: enable Sphinx nitpicky #1916

Merged
merged 51 commits into from
Aug 16, 2023
Merged

docs: enable Sphinx nitpicky #1916

merged 51 commits into from
Aug 16, 2023

Conversation

Borda
Copy link
Member

@Borda Borda commented Jul 13, 2023

What does this PR do?

nitpicky
If true, Sphinx will warn about all references where the target cannot be found. Default is False. You can activate this mode temporarily using the -n command-line switch.

ref: optuna/optuna#4213

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--1916.org.readthedocs.build/en/1916/

@Borda Borda added bug / fix Something isn't working documentation Improvements or additions to documentation enhancement New feature or request test / CI testing or CI labels Jul 13, 2023
@Borda Borda requested a review from awaelchli as a code owner July 13, 2023 08:13
@Borda
Copy link
Member Author

Borda commented Jul 13, 2023

So not sure how to tell sphinx mapping also, this just built package... :/

@Borda
Copy link
Member Author

Borda commented Jul 13, 2023

also these seem to be missing WARNING: py:class reference target not found: torch.FloatTensor

@codecov
Copy link

codecov bot commented Jul 13, 2023

Codecov Report

Merging #1916 (c9c3afc) into master (23356d4) will not change coverage.
The diff coverage is 100%.

Additional details and impacted files
@@          Coverage Diff           @@
##           master   #1916   +/-   ##
======================================
  Coverage      87%     87%           
======================================
  Files         268     268           
  Lines       15427   15427           
======================================
  Hits        13360   13360           
  Misses       2067    2067           

@mergify mergify bot added the ready label Jul 17, 2023
@stancld stancld enabled auto-merge (squash) July 24, 2023 20:21
@mergify mergify bot added ready and removed ready labels Jul 27, 2023
@Borda
Copy link
Member Author

Borda commented Jul 28, 2023

Ok, checked some and seems some links are really wrong so need to get fixed...

@Borda
Copy link
Member Author

Borda commented Aug 1, 2023

lets wait for #1956 and #1958

@mergify mergify bot removed the ready label Aug 8, 2023
@mergify mergify bot added the ready label Aug 8, 2023
@Borda Borda mentioned this pull request Aug 10, 2023
5 tasks
@SkafteNicki SkafteNicki added this to the v1.1.0 milestone Aug 14, 2023
@SkafteNicki SkafteNicki mentioned this pull request Aug 15, 2023
4 tasks
@Borda
Copy link
Member Author

Borda commented Aug 15, 2023

THANK YOU @SkafteNicki 💜 only 177 left... and remarkable finding with #1998

@Borda Borda disabled auto-merge August 16, 2023 12:13
@Borda Borda merged commit 3b3b997 into master Aug 16, 2023
60 of 61 checks passed
@Borda Borda deleted the docs/nitpicky branch August 16, 2023 12:13
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 enhancement New feature or request ready test / CI testing or CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants