diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1c3c58a24b20..a7b0ee68ae8b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -106,6 +106,13 @@ Mypy install and run. \> tox -e mypy -c ``` +#### `sphinx` environment +Generate shpinx doc for this package. + +``` +\> tox -e sphinx -c +``` + ### Custom Pytest Arguments `tox` supports custom arguments, and the defined pytest environments within the common `tox.ini` also allow these. Essentially, separate the arguments you want passed to `pytest` by a `--` in your tox invocation.