-
Notifications
You must be signed in to change notification settings - Fork 138
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
Support for sphinx >= 3 #115
Comments
This is caused by If I do I think the following line is causing the issue, but someone needs to build CSS and verify. pytorch_sphinx_theme/scss/_sphinx_base.scss Line 377 in 0efb4da
|
We actually moved to 3.5.4 for docs, so I think we're good now. https://github.com/pytorch/pytorch/blob/master/docs/requirements.txt |
@brianjo No, sphinx 3 is still broken for type annotations, please see #134 (comment) and #134 (comment) Pytorch docs will be broken as soon as they start having signatures with type annotations. |
There's a 1 line fixed suggested above. @NicolasHug can you try it out and send a PR if it fixes the issue? |
Sorry, I have zero css ability, so unfortunately I can't assess the suitability of the proposed solution |
All of Pytorch, torchaudio, torchtext, and torchvision pin the sphinx version to 2.4.4 because of rendering issues when ugprading to sphinx 3 (pytorch/audio#972, pytorch/vision#3681)
For example this signature renders fine in 2.4.4:
But it doesn't render properly with sphinx 3 (various annotations are missing, etc.):
Are there plans to add support for
sphinx>=3
?CC @brianjo @holly1238
The text was updated successfully, but these errors were encountered: