Joel Schlosser
8573da59c3
Re-enable C++ doc generation ( #81719 )
...
Reverts #80451 , as this caused problems reported by many internal and external users. The generated C++ docs are used, even if they are lacking in human-generated content.
Fixes #80505
Pull Request resolved: https://github.com/pytorch/pytorch/pull/81719
Approved by: https://github.com/kit1980 , https://github.com/albanD
2022-07-20 19:54:47 +00:00
Joel Benjamin Schlosser
f70bf13c6e
Disable doxygen / breathe / exhale generation of C++ API docs ( #80451 )
...
Fixes #79992
This PR:
* Removes doxygen / breathe / exhale configuration from the Sphinx config in `source/conf.py` so it no longer runs
* Maintains the human-generated content describing API usage in the various .rst files
* Exception: `library.rst` is removed, as its main purpose is linking to API docs
* Removes all links to the generated API docs from the human-generated content
The build is nearly instantaneous now and should be much less memory intensive as well.
Pull Request resolved: https://github.com/pytorch/pytorch/pull/80451
Approved by: https://github.com/suo
2022-06-28 17:56:41 +00:00
Will Feng (FAIAR)
86f3305859
Improve C++ API autograd and indexing docs ( #35777 )
...
Summary:
This PR adds docs for the following components:
1. Tensor autograd APIs (such as `is_leaf` / `backward` / `detach` / `detach_` / `retain_grad` / `grad` / `register_hook` / `remove_hook`)
2. Autograd APIs: `torch::autograd::backward` / `grad` / `Function` / `AutogradContext`, `torch::NoGradGuard` / `torch::AutoGradMode`
3. Tensor indexing
Pull Request resolved: https://github.com/pytorch/pytorch/pull/35777
Differential Revision: D20810616
Pulled By: yf225
fbshipit-source-id: 60526ec0c5b051021901d89bc3b56861c68758e8
2020-04-02 09:33:11 -07:00
Will Feng (FAIAR)
b33ae23c5a
Revert D20794765: [pytorch][PR] Improve C++ API autograd and indexing docs
...
Test Plan: revert-hammer
Differential Revision:
D20794765
Original commit changeset: fad623e5d505
fbshipit-source-id: 041fb7257d4978a3767d8229d70d6f3cc55e5f28
2020-04-01 20:14:13 -07:00
Will Feng (FAIAR)
41ef2c0d58
Improve C++ API autograd and indexing docs ( #35777 )
...
Summary:
This PR adds docs for the following components:
1. Tensor autograd APIs (such as `is_leaf` / `backward` / `detach` / `detach_` / `retain_grad` / `grad` / `register_hook` / `remove_hook`)
2. Autograd APIs: `torch::autograd::backward` / `grad` / `Function` / `AutogradContext`, `torch::NoGradGuard` / `torch::AutoGradMode`
3. Tensor indexing
Pull Request resolved: https://github.com/pytorch/pytorch/pull/35777
Differential Revision: D20794765
Pulled By: yf225
fbshipit-source-id: fad623e5d505b7cfcd76a8c5264f18b7a0a3298c
2020-04-01 16:54:08 -07:00
