Skip to content

fix: sphinx docs build error due to warnings#3306

Merged
justusschock merged 17 commits into
Lightning-AI:masterfrom
bhimrazy:fix/docs-build-errors
Dec 17, 2025
Merged

fix: sphinx docs build error due to warnings#3306
justusschock merged 17 commits into
Lightning-AI:masterfrom
bhimrazy:fix/docs-build-errors

Conversation

@bhimrazy

@bhimrazy bhimrazy commented Nov 25, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

What does this PR do?

Fixes docs build in master branch.

image 
WARNING: py:data reference target not found: typing.Union
--
build finished with problems, 582 warnings.
make: *** [Makefile:31: html] Error 1

ref: https://github.com/Lightning-AI/torchmetrics/actions/runs/18839686293/job/53748746696

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

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 25, 2025
@bhimrazy bhimrazy changed the title docs: add nitpicky_ignore for typing.Union in Sphinx configuration docs: add nitpicky_ignore for typing.Union in Sphinx configuration to fix build docs Nov 25, 2025
@bhimrazy bhimrazy changed the title docs: add nitpicky_ignore for typing.Union in Sphinx configuration to fix build docs fix: sphinx docs build error due to warnings Nov 27, 2025
@bhimrazy
bhimrazy marked this pull request as draft November 28, 2025 07:00
@bhimrazy bhimrazy mentioned this pull request Nov 28, 2025
Closed
4 tasks
@bhimrazy
bhimrazy marked this pull request as ready for review November 28, 2025 09:24
@mergify mergify Bot added the ready label Dec 1, 2025
@Borda

Borda commented Dec 1, 2025

Copy link
Copy Markdown
Collaborator

build HTML is still failing: https://github.com/Lightning-AI/torchmetrics/actions/runs/19759714343/job/56757882195?pr=3306

@bhimrazy

bhimrazy commented Dec 1, 2025

Copy link
Copy Markdown
Collaborator Author

build HTML is still failing: https://github.com/Lightning-AI/torchmetrics/actions/runs/19759714343/job/56757882195?pr=3306

yes @Borda , the failure seems related with CI spacing.
image

do we need to clear some cache or try something else to fix this?

@Borda

Borda commented Dec 1, 2025

Copy link
Copy Markdown
Collaborator

we need to clear some cache or try something else to fix this?

You can nuke the cache and prove that the cache is the problem, you can just disable it in the workflow

@mergify mergify Bot added ready and removed ready labels Dec 3, 2025
Copilot AI review requested due to automatic review settings December 3, 2025 16:45
@bhimrazy
fix: add missing UV_TORCH_BACKEND environment variable in docs build …
e8058f2 
…workflow
@bhimrazy
fix spacing
2c69340
@bhimrazy
try again without cache cleanup;
2d929a5 
Revert "refactor: remove unused PYPI_CACHE variable and update disk space cleanup step"

This reverts commit 03916b4.
@bhimrazy

bhimrazy commented Dec 3, 2025

Copy link
Copy Markdown
Collaborator Author

Finally, the failing build issue is resolved. 🚀

Copilot AI reviewed Dec 3, 2025

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@bhimrazy
bhimrazy requested a review from Copilot December 3, 2025 17:47
@codecov

codecov Bot commented Dec 3, 2025 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 37%. Comparing base (88bca94) to head (b9deabd).
⚠️ Report is 15 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master   #3306    +/-   ##
=======================================
- Coverage      37%     37%    -1%     
=======================================
  Files         364     349    -15     
  Lines       20096   19901   -195     
=======================================
- Hits         7520    7326   -194     
+ Misses      12576   12575     -1
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI reviewed Dec 3, 2025
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mergify mergify Bot removed the ready label Dec 12, 2025
@justusschock
justusschock merged commit 9896fec into Lightning-AI:master Dec 17, 2025
48 of 59 checks passed
@bhimrazy
bhimrazy deleted the fix/docs-build-errors branch December 17, 2025 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments
@Borda Borda Borda approved these changes
@justusschock justusschock justusschock approved these changes
@SkafteNicki SkafteNicki SkafteNicki approved these changes
@lantiga lantiga Awaiting requested review from lantiga
@ethanwharris ethanwharris Awaiting requested review from ethanwharris ethanwharris is a code owner

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@bhimrazy @Borda @justusschock @SkafteNicki