riaz.somc/transformers
1
0
Fork 0
mirror of https://github.com/huggingface/transformers.git synced 2025-07-03 12:50:06 +06:00
Code Issues Actions 28 Packages Projects Releases Wiki Activity

new Makefile target: docs (#6510)

Browse Source 
* [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
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -165,6 +165,16 @@ Follow these steps to start contributing:
$ make quality $ 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 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: make a commit with `git commit` to record your changes locally:

7
Makefile
View File

@ -1,4 +1,4 @@
.PHONY: quality style test test-examples .PHONY: quality style test test-examples docs
# Check that source code meets quality standards # Check that source code meets quality standards
@ -23,3 +23,8 @@ test:
test-examples: test-examples:
python -m pytest -n auto --dist=loadfile -s -v ./examples/ python -m pytest -n auto --dist=loadfile -s -v ./examples/
# Check that docs can build
docs:
cd docs && make html SPHINXOPTS="-W"