b3bd57cf18
Setup repo for usual Sphinx location: * content lives in doc/source * Add tox.ini for building with linter and docs job * Add doc/source/conf.py for Sphinx * Add index file to build a manual * Add jobs for Zuul; note that tox-linters is non-voting for now, fixing issues can be done as followup. The docs job has Sphinx warnings disabled, this will be a followup as well. * Add .gitignore for usual build artefacts Change-Id: Ie7af4b6bd661e61180528cc1ecf3076e3e95590b
23 lines
395 B
INI
23 lines
395 B
INI
[tox]
|
|
minversion = 2.0
|
|
skipsdist = True
|
|
envlist = docs,linters
|
|
|
|
[testenv]
|
|
basepython = python3
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
passenv = *_proxy *_PROXY ZUUL_*
|
|
|
|
[testenv:linters]
|
|
deps =
|
|
-r{toxinidir}/test-requirements.txt
|
|
commands =
|
|
doc8 doc/source
|
|
|
|
[testenv:docs]
|
|
deps =
|
|
-r{toxinidir}/test-requirements.txt
|
|
commands =
|
|
sphinx-build -b html -d doc/build/doctrees doc/source doc/build/html
|
|
|