pytorch
786431cd - [DOC] Use type hints to show annotation in the docs (#86851)

Commit
3 years ago
[DOC] Use type hints to show annotation in the docs (#86851) Fixes #44964 Use type hints in the code to show type annotations in the parameters section of the docs. For the parameters already documented in the docstring, but lack the type annotation, the type hints from the code are used: | [Before](https://pytorch.org/docs/master/generated/torch.nn.AdaptiveMaxPool1d.html) | [After](https://docs-preview.pytorch.org/79086/generated/torch.nn.AdaptiveMaxPool1d.html) | | --- | --- | | <img width="462" alt="image" src="https://user-images.githubusercontent.com/6421097/172954756-96d2d8a6-7df9-4c0f-ad34-c12912a5a740.png"> | <img width="479" alt="image" src="https://user-images.githubusercontent.com/6421097/172954770-a6ce2425-99a6-4853-ac2c-e182c3849344.png"> | | [Before](https://pytorch.org/docs/master/generated/torch.nn.Linear.html) | [After](https://docs-preview.pytorch.org/79086/generated/torch.nn.Linear.html) | | --- | --- | | <img width="482" alt="image" src="https://user-images.githubusercontent.com/6421097/172954992-10ce6b48-44a2-487e-b855-2a15a50805bb.png"> | <img width="471" alt="image" src="https://user-images.githubusercontent.com/6421097/172954839-84012ce6-bf42-432c-9226-d3e81500e72d.png"> | Ref: - PR https://github.com/pytorch/pytorch/pull/49294 removed type annotations from signatures in HTML docs. - Sphinx version was bumped to 5.0.0 in PR #70309 - Duplicated (closed) issues: #78311 and #77501 Pull Request resolved: https://github.com/pytorch/pytorch/pull/79086 Approved by: https://github.com/malfet (cherry picked from commit e552cf105058e6d7ea367d31ff3d3c0a31ea0bbd) Co-authored-by: Shawn Zhong <github@shawnzhong.com>
Author
Parents
Loading