new Makefile target: docs (#6510)

* [doc] multiple corrections to "Summary of the tasks"

* add a new "docs" target to validate docs and document it

* fix mixup
This commit is contained in:
Stas Bekman
2020-08-27 09:25:16 -07:00
committed by GitHub
parent dbfe34f2f5
commit 70fccc5cf3
2 changed files with 16 additions and 1 deletions

View File

@@ -165,6 +165,16 @@ Follow these steps to start contributing:
$ make quality
```
If you're modifying documents under `docs/source`, make sure to validate that
they can still be built. This check also runs in CI. To run a local check
make sure you have installed the documentation builder requirements, by
running `pip install .[tf,torch,docs]` once from the root of this repository
and then run:
```bash
$ make docs
```
Once you're happy with your changes, add changed files using `git add` and
make a commit with `git commit` to record your changes locally: