-
Notifications
You must be signed in to change notification settings - Fork 25.6k
Fix nightly build of C++ docs #100845
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
Fix nightly build of C++ docs #100845
Conversation
🔗 Helpful Links🧪 See artifacts and rendered test results at hud.pytorch.org/pr/100845
Note: Links to docs will display an error until the docs builds have been completed. ✅ No FailuresAs of commit 67066e1: This comment was automatically generated by Dr. CI and updates every 15 minutes. |
.github/workflows/pull.yml
Outdated
with: | ||
build-environment: linux-focal-py3.8-gcc7 | ||
docker-image: ${{ needs.linux-focal-py3_8-gcc7-build.outputs.docker-image }} | ||
run-doxygen: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is for testing in PR. I will remove this line before merging.
@pytorchbot merge -f 'Doc and lint jobs have passed. There is no need to run trunk jobs for this change' |
Merge startedYour change will be merged immediately since you used the force (-f) flag, bypassing any CI checks (ETA: 1-5 minutes). Learn more about merging in the wiki. Questions? Feedback? Please reach out to the PyTorch DevX Team |
The fix is to upgrade breathe version (and sphinx accordingly), for example https://github.com/pytorch/pytorch/actions/runs/4898593997/jobs/8749163278.
This was missed in #100601 because
RUN_DOXYGEN
is only set to true in the nightly job. Specifically, the 2 pluginsbreathe
andexhale
are only used whenRUN_DOXYGEN
is set to true https://github.com/pytorch/pytorch/blob/main/docs/cpp/source/conf.py#L37-L42Testing
https://github.com/pytorch/pytorch/actions/runs/4910813882/jobs/8771541636 passes with RUN_DOXYGEN set to true and C++ docs looks ok https://docs-preview.pytorch.org/100845/cppdocs/index.html