diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9d84a52 --- /dev/null +++ b/.gitignore @@ -0,0 +1,60 @@ +*.py[cod] + +# C extensions +*.so + +# Packages +*.egg* +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg +lib +lib64 + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +cover/ +.coverage* +!.coveragerc +.tox +nosetests.xml +.stestr/ +.venv + +# Translations +*.mo + +# Mr Developer +.mr.developer.cfg +.project +.pydevproject + +# Complexity +output/*.html +output/*/index.html + +# Sphinx +doc/build +doc/source/reference/api + +# pbr generates these +AUTHORS +ChangeLog + +# Editors +*~ +.*.swp +.*sw? + +# Files created by releasenotes build +releasenotes/build + diff --git a/.zuul.yaml b/.zuul.yaml index 0b68faa..46a4fa6 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -1,4 +1,8 @@ - project: templates: - - openstack-python3-ussuri-jobs - check-requirements + - openstack-cover-jobs + - openstack-lower-constraints-master-branch-jobs + - openstack-python3-yoga-jobs + - publish-openstack-docs-pti + - release-notes-jobs-python3 diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..d8817fb --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,7 @@ +openstackdocstheme>=2.2.0 # Apache-2.0 +os-api-ref>=1.4.0 # Apache-2.0 +reno>=3.1.0 # Apache-2.0 +sphinx>=2.0.0,!=2.1.0 # BSD +sphinxcontrib-apidoc>=0.2.0 # BSD +sphinxcontrib-seqdiag>=0.8.4 # BSD +sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 5f2815a..f70b0f6 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,7 +3,6 @@ # process, which may cause wedges in the gate later. pbr>=1.6 # Apache-2.0 - daemonize PyMySQL>=0.6.2,!=0.7.7 # MIT License pyyaml diff --git a/test-requirements.txt b/test-requirements.txt index 761b0dd..2a1dac1 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,15 +3,9 @@ # process, which may cause wedges in the gate later. hacking>=0.11.0,<0.12 # Apache-2.0 - coverage>=4.0 # Apache-2.0 python-subunit>=0.0.18 # Apache-2.0/BSD -sphinx>=1.2.1,!=1.3b1,<1.4 # BSD -openstackdocstheme>=1.11.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD testtools>=1.4.0 # MIT - -# releasenotes -reno>=1.8.0 # Apache2 diff --git a/tox.ini b/tox.ini index 1e911c9..241e243 100644 --- a/tox.ini +++ b/tox.ini @@ -1,8 +1,8 @@ [tox] -minversion = 3.1.0 -envlist = py3,pypy,pep8 -ignore_basepython_conflict = True +minversion = 3.18.0 skipsdist = True +envlist = py3,pep8 +ignore_basepython_conflict=true [testenv] basepython = python3 @@ -14,7 +14,7 @@ deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} -r{toxinidir}/test-requirements.txt # Don't worry about installing bash commands in the virtual environment. -whitelist_externals = mkdir +allowlist_externals = mkdir diff #commands = python setup.py test --slowest --testr-args='{posargs}' commands = mkdir -p testenv/var/run/ @@ -96,10 +96,24 @@ commands = {posargs} commands = python setup.py test --coverage --testr-args='{posargs}' [testenv:docs] +deps = + -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -r{toxinidir}/requirements.txt + -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -b html -W doc/source doc/build/html + +[testenv:pdf-docs] +allowlist_externals = make +deps = {[testenv:docs]deps} commands = - sphinx-build -W -d doc/build/doctrees -b html doc/source doc/build/html + sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf [testenv:releasenotes] +usedevelop = False +deps = + -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} + -r{toxinidir}/doc/requirements.txt commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html