pytorch/docs/source/notes
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
..
amp_examples.rst Amp gradient accumulation example (#36601) 2020-04-17 09:56:36 -07:00
autograd.rst [autograd] add documentation about multithread autograd (#37020) 2020-04-27 15:53:21 -07:00
broadcasting.rst [docs] Update broadcasting and cuda semantics notes (#6904) 2018-04-24 13:41:24 -04:00
cpu_threading_runtimes.svg Update CPU threading doc (#33083) 2020-02-11 14:13:51 -08:00
cpu_threading_torchscript_inference.rst Upgrade MKL-DNN to DNNL v1.2 (#32422) 2020-03-26 22:07:59 -07:00
cpu_threading_torchscript_inference.svg Threading and CPU Inference note 2019-07-29 15:45:49 -07:00
cuda.rst Update docs about DP and DDP for CUDA (#35063) 2020-03-20 20:06:37 -07:00
ddp.rst Adding DDP Design Note 2020-01-15 14:10:45 -08:00
extending.rst Fix many doc issues (#37099) 2020-04-23 10:01:03 -07:00
faq.rst Split up documentation into subpages and clean up some warnings (#37419) 2020-05-04 09:39:22 -07:00
large_scale_deployments.rst [resubmit] Enable global observers API (#37382) 2020-04-28 10:49:31 -07:00
multiprocessing.rst Update docs for master to remove Python 2 references (#36336) 2020-04-16 10:15:48 -07:00
randomness.rst Enhance reproducibility documentation (#33795) 2020-03-06 15:32:04 -08:00
serialization.rst code syntax error in document (serialization.rst) (#937) 2017-03-06 10:06:04 -05:00
windows.rst Update docs for master to remove Python 2 references (#36336) 2020-04-16 10:15:48 -07:00