pytorch/docs/source
mattip f10fbcc820 Split up documentation into subpages and clean up some warnings (#37419)
Summary:
xref gh-32838, gh-34032

This is a major refactor of parts of the documentation to split it up using sphinx's `autosummary` feature which will build out `autofuction` and `autoclass` stub files and link to them. The end result is that the top module pages like torch.nn.rst and torch.rst are now more like table-of-contents to the actual single-class or single-function documentations pages.

Along the way, I modified many of the docstrings to eliminate sphinx warnings when building. I think the only thing I changed from a non-documentation perspective is to add names to `__all__` when adding them to `globals()` in `torch.__init__.py`

I do not know the CI system: are the documentation build artifacts available after the build, so reviewers can preview before merging?
Pull Request resolved: https://github.com/pytorch/pytorch/pull/37419

Differential Revision: D21337640

Pulled By: ezyang

fbshipit-source-id: d4ad198780c3ae7a96a9f22651e00ff2d31a0c0f
2020-05-04 09:39:22 -07:00
..
_static Improve documentation around builtin functions (#30347) 2019-12-04 13:50:40 -08:00
_templates Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
_templates-stable Add layout.html to template for stable docs (#33770) 2020-03-04 03:14:52 -08:00
community Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
notes Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
org/pytorch Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
rpc Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
scripts Add torch.nn.GELU for GELU activation (#28944) 2019-11-03 21:55:05 -08:00
__config__.rst Allow a non-OpenMP based build (#19749) 2019-05-06 19:34:48 -07:00
amp.rst [RELAND2] Eager autocasting, out-of-place ops only (with MSVC 2017 fix) (#35102) 2020-03-24 09:08:04 -07:00
autograd.rst functional autograd api (#34066) 2020-03-19 08:24:07 -07:00
bottleneck.rst
checkpoint.rst Stashing checkpointing RNG states based on devices of arg tensors (#14518) 2018-12-11 09:48:45 -08:00
conf.py Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
cpp_extension.rst
cuda.rst Fix most documentation warnings (#27782) 2019-10-13 10:34:01 -07:00
cudnn_persistent_rnn.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
data.rst Fix typo in data.rst (#34624) 2020-03-11 19:40:18 -07:00
distributed.rst Expose torch.distributed.is_available() API (#37021) 2020-04-21 18:38:46 -07:00
distributions.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
dlpack.rst document torch.utils.dlpack (#9343) 2018-07-11 07:46:09 -07:00
docutils.conf Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
hub.rst Fix typos, via a Levenshtein-type corrector (#31523) 2020-01-17 16:03:19 -08:00
index.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
jit_builtin_functions.rst Fix builtin function reference (#24056) 2019-08-09 15:58:15 -07:00
jit_language_reference.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
jit_python_reference.rst Add Python language reference docs (#30686) 2019-12-26 13:21:36 -08:00
jit_unsupported.rst add support for generating Vandermonde matrices (#36725) 2020-04-29 13:16:26 -07:00
jit.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
math-quantizer-equation.png adding quantization.rst file for quantization feature (#27559) 2019-10-09 16:45:09 -07:00
model_zoo.rst add/move a few apis in torch.hub (#18758) 2019-04-10 23:10:39 -07:00
multiprocessing.rst Update docs for master to remove Python 2 references (#36336) 2020-04-16 10:15:48 -07:00
name_inference.rst Fix typos (#30606) 2019-12-02 20:17:42 -08:00
named_tensor.rst Update docs for master to remove Python 2 references (#36336) 2020-04-16 10:15:48 -07:00
nn.functional.rst Breaks up NN module in docs so it loads faster. 2019-06-11 09:38:41 -07:00
nn.init.rst Bag of documentation fixes; fix more sphinx warnings (#27850) 2019-10-15 07:31:14 -07:00
nn.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
onnx.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
optim.rst Fix capitalization inconsistency in optim.rst 2019-12-04 08:17:03 -08:00
packages.rst Revert D19320493: Javadoc changes 2020-01-09 14:23:30 -08:00
quantization.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
random.rst Fix most documentation warnings (#27782) 2019-10-13 10:34:01 -07:00
rpc.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
sparse.rst Bag of documentation fixes; fix more sphinx warnings (#27850) 2019-10-15 07:31:14 -07:00
storage.rst
tensor_attributes.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
tensor_view.rst Update view op list. (#35399) 2020-03-25 16:15:00 -07:00
tensorboard.rst Add method add_hparams to API doc (#27344) 2019-10-03 17:07:45 -07:00
tensors.rst Add Inverse Short Time Fourier Transform in ATen native (#35569) 2020-04-24 12:14:55 -07:00
torch.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
type_info.rst Allow converting char tensor to numpy; add [fi]info.min (#15046) 2018-12-24 09:11:24 -08:00