f81cf9a905
Follow PTI [1] for doc building: * Create doc/requirements.txt file with all docs requirements. * Switch to openstackdocstheme and update conf.py for this. * Move doc8 to pep8 section since it's a linter. Additionally: * Fix all build errors with doc building. * Update requirements list with license info. * Use hacking instead of flake directly. * Remove unused _static files, those are not needed. * Update git URLs, fix contributor guide URL * Move README.md to RST, everything else in this repo is RST * Publish documents to docs.o.o - note that https://adjutant.readthedocs.io/en/latest/ was last updated in March 2018 This adds jobs for building of release notes - only building since there's no content yet - and publishing of documentation. Publishing of api-ref can be done via: https://review.opendev.org/675766 [1] https://governance.openstack.org/tc/reference/project-testing-interface.html#documentation Change-Id: I82f56ef5ea800899b2a8db795b6cf2b21d03ac7a
61 lines
1.6 KiB
INI
61 lines
1.6 KiB
INI
[tox]
|
|
envlist = py3,py27,pep8,cover_report
|
|
skipsdist = True
|
|
|
|
[testenv]
|
|
usedevelop = True
|
|
deps = -r{toxinidir}/requirements.txt
|
|
-r{toxinidir}/test-requirements.txt
|
|
commands = adjutant-api test {posargs}
|
|
setenv = VIRTUAL_ENV={envdir}
|
|
|
|
[testenv:pep8]
|
|
basepython = python3
|
|
commands =
|
|
flake8
|
|
doc8
|
|
|
|
[testenv:cover]
|
|
basepython = python3
|
|
commands =
|
|
coverage run --source='adjutant' .tox/cover/bin/adjutant-api test {posargs}
|
|
coverage html -d cover
|
|
coverage xml -o cover/coverage.xml
|
|
|
|
[testenv:cover_report]
|
|
basepython = python3
|
|
commands =
|
|
coverage run --source='.' .tox/cover_report/bin/adjutant-api test {posargs}
|
|
coverage report --include adjutant/* -m
|
|
|
|
[testenv:venv]
|
|
basepython = python3
|
|
commands = {posargs}
|
|
|
|
[testenv:docs]
|
|
basepython = python3
|
|
deps = -r{toxinidir}/doc/requirements.txt
|
|
commands =
|
|
sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
|
|
|
|
[testenv:api-ref]
|
|
basepython = python3
|
|
deps = {[testenv:docs]deps}
|
|
commands =
|
|
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
|
|
|
|
[testenv:releasenotes]
|
|
basepython = python3
|
|
deps = {[testenv:docs]deps}
|
|
commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
|
|
|
|
[flake8]
|
|
ignore = D100,D101,D102,D103,D104,D105,D200,D203,D202,D204,D205,D208,D400,D401,W503
|
|
show-source = true
|
|
builtins = _
|
|
exclude=.venv,venv,.env,env,.git,.tox,dist,doc,*lib/python*,*egg,releasenotes,adjutant/api/migrations/*,adjutant/actions/migrations
|
|
|
|
[doc8]
|
|
ignore-path=.tox,*.egg-info,doc/build,.eggs/*/EGG-INFO/*.txt,./*.txt,adjutant
|
|
extension=.txt,.rst,.inc
|