From da36bbcd353d029ad93b2a22acb00c83d1bfe9a1 Mon Sep 17 00:00:00 2001 From: Richard Zou Date: Mon, 16 Aug 2021 15:35:05 -0700 Subject: [PATCH] Add section to CONTRIBUTING.md explaining developer docs (#63228) Summary: Pull Request resolved: https://github.com/pytorch/pytorch/pull/63228 It is a quick summary and links to a page on the Developer Wiki that has more detail. Test Plan: Imported from OSS Reviewed By: SplitInfinity Differential Revision: D30347109 Pulled By: zou3519 fbshipit-source-id: a6242986d275e5279ca3f61ade2294a132d268c4 --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d918e3f..66dbec2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -464,6 +464,17 @@ of very low signal to reviewers. ## Writing documentation +So you want to write some documentation and don't know where to start? +PyTorch has two main types of documentation: +- user-facing documentation. +These are the docs that you see over at [our docs website](pytorch.org/docs). +- developer facing documentation. +Developer facing documentation is spread around our READMEs in our codebase and in +the [PyTorch Developer Wiki](pytorch.org/wiki). +If you're interested in adding new developer docs, please read this [page on the wiki](https://github.com/pytorch/pytorch/wiki/Where-or-how-should-I-add-documentation%3F) on our best practices for where to put it. + +The rest of this section is about user-facing documentation. + PyTorch uses [Google style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) for formatting docstrings. Length of line inside docstrings block must be limited to 80 characters to fit into Jupyter documentation popups. -- 2.7.4