recordsansible
/
ara
Code Issues Proposed changes

docs: isolate docs requirements and add API server dependencies 

This will allow us to build the docs properly for hosting on
readthedocs.

Change-Id: I6770146239350c1b4e0bed880a3bc9c7239eaa79
This commit is contained in:
David Moreau Simard 2019-11-28 10:10:58 -05:00
parent efd667a83d
commit 6ae9af6858
No known key found for this signature in database
GPG Key ID: 938880DAFC753E80
3 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
doc/requirements.txt Normal file
View File

@ -0,0 +1,14 @@
sphinx>=1.4
sphinx-rtd-theme
sphinxcontrib-programoutput
# For programoutput, we need to include server extra dependencies from setup.cfg
Django>=2.1.5
djangorestframework>=3.9.1
django-cors-headers
django-filter
django-health-check
dynaconf[yaml]
tzlocal
whitenoise
pygments

5
test-requirements.txt
View File

@ -2,8 +2,7 @@ factory-boy
bandit>=1.1.0 # Apache-2.0
coverage
flake8
sphinx>=1.4
sphinx-rtd-theme
sphinxcontrib-programoutput
black==19.3b0 # Exact version for prerelease
isort
# requirements for docs are in doc/requirements.txt

2
tox.ini
View File

@ -16,9 +16,11 @@ extras = server
commands = {posargs}
[testenv:docs]
deps = -r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -W -b html doc/source doc/build/html
setenv =
# programoutput might end up creating things, don't pollute outside of tov envtmpdir
ARA_BASE_DIR={env:ARA_BASE_DIR:{envtmpdir}}
[testenv:linters]