frozenleaves/pytorch
1
0
Fork 0
mirror of https://github.com/pytorch/pytorch.git synced 2025-10-20 21:14:14 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs build to specify <3.13 in CONTRIBUTING (#155140)

Browse Source 
Python 3.13 removed the deprecated imghdr module, so our docs build does not compile with 3.13+. Mention it in our contributing guide so people know before committing to the wrong version oop.

Pull Request resolved: https://github.com/pytorch/pytorch/pull/155140
Approved by: https://github.com/drisspg, https://github.com/cyyever
ghstack dependencies: #155126
This commit is contained in:
Jane Xu
2025-06-04 11:10:41 -07:00
committed by PyTorch MergeBot
parent 2f3f8339ec
commit e895e9689c
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -473,7 +473,7 @@ In addition to the standard Google Style docstring formatting rules, the followi
### Building documentation
To build the documentation:
Note that the docs will only build with Python versions <3.13. To build the documentation:
1. Build and install PyTorch
@ -583,9 +583,8 @@ rsync -az me@my_machine:/path/to/pytorch/docs/cpp/build/html cpp/build
### Previewing documentation on PRs
PyTorch will host documentation previews at `https://docs-preview.pytorch.org/pytorch/pytorch/<pr number>/index.html` once the
`pytorch_python_doc_build` GitHub Actions job has completed on your PR. You can visit that page directly
or find its link in the automated Dr. CI comment on your PR.
PyTorch will host documentation previews at `https://docs-preview.pytorch.org/pytorch/pytorch/<pr number>/index.html` once the docs GitHub Actions job has completed on your PR. You can find its link in the automated pytorchbot comment on your PR or go to the URL
directly.
### Adding documentation tests