Create a tox docs environment (#1426)

To make it easier to build documentation locally, add a new tox
environment that installs our requirements and runs Sphinx.
This commit is contained in:
Steve Kowalik
2020-03-08 16:36:52 +11:00
committed by GitHub
parent 3d93ee1ce5
commit b30c09aaa4
2 changed files with 13 additions and 1 deletions
+7 -1
View File
@@ -104,7 +104,7 @@ pip install --editable path/to/project
You may also want to investigate `tox` to run tests:
``
```
pip install tox
tox -epy36,flake8,black,isort
```
@@ -115,3 +115,9 @@ tox -epy36,flake8,black,isort
pip install -r requirements.txt
sphinx-build doc build
```
If you use tox:
```
tox -edocs
```
+6
View File
@@ -37,6 +37,12 @@ commands =
isort -rc github tests scripts setup.py
black github tests scripts setup.py
[testenv:docs]
basepython = python3.6
skip_install = true
deps = -rrequirements.txt
commands = sphinx-build doc build
[flake8]
max-line-length = 88
select = C,E,F,W