Skip to content

Conversation

huydhn
Copy link
Contributor

@huydhn huydhn commented May 8, 2023

The fix is to upgrade breathe version (and sphinx accordingly), for example https://github.com/pytorch/pytorch/actions/runs/4898593997/jobs/8749163278.

Exception occurred:
  File "/opt/conda/envs/py_3.8/lib/python3.8/site-packages/breathe/renderer/sphinxrenderer.py", line 104, in DomainDirectiveFactory
    'function': (python.PyModulelevel, 'function'),
AttributeError: module 'sphinx.domains.python' has no attribute 'PyModulelevel'

This was missed in #100601 because RUN_DOXYGEN is only set to true in the nightly job. Specifically, the 2 plugins breathe and exhale are only used when RUN_DOXYGEN is set to true https://github.com/pytorch/pytorch/blob/main/docs/cpp/source/conf.py#L37-L42

Testing

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

@pytorch-bot
Copy link

pytorch-bot bot commented May 8, 2023

🔗 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 Failures

As of commit 67066e1:
💚 Looks good so far! There are no failures yet. 💚

This comment was automatically generated by Dr. CI and updates every 15 minutes.

@pytorch-bot pytorch-bot bot added the topic: not user facing topic category label May 8, 2023
@huydhn huydhn requested a review from clee2000 May 8, 2023 08:09
@huydhn huydhn marked this pull request as ready for review May 8, 2023 08:09
@huydhn huydhn requested review from a team and jeffdaily as code owners May 8, 2023 08:09
with:
build-environment: linux-focal-py3.8-gcc7
docker-image: ${{ needs.linux-focal-py3_8-gcc7-build.outputs.docker-image }}
run-doxygen: true
Copy link
Contributor Author

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.

@huydhn
Copy link
Contributor Author

huydhn commented May 8, 2023

@pytorchbot merge -f 'Doc and lint jobs have passed. There is no need to run trunk jobs for this change'

@pytorchmergebot
Copy link
Collaborator

Merge started

Your 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

Advanced Debugging
Check the merge workflow status
here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants