diff --git a/.zuul.yaml b/.zuul.yaml index 5160dcff6..9c16647e3 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -201,11 +201,17 @@ - osc-tox-unit-tips check: jobs: + - build-openstack-sphinx-docs: + vars: + sphinx_python: python3 - openstacksdk-functional-devstack - openstacksdk-functional-devstack-magnum: voting: false - openstacksdk-functional-devstack-python3 gate: jobs: + - build-openstack-sphinx-docs: + vars: + sphinx_python: python3 - openstacksdk-functional-devstack - openstacksdk-functional-devstack-python3 diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..1ff13a32b --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,5 @@ +sphinx>=1.6.2 # BSD +docutils>=0.11 # OSI-Approved Open Source, Public Domain +openstackdocstheme>=1.17.0 # Apache-2.0 +beautifulsoup4>=4.6.0 # MIT +reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/enforcer.py b/doc/source/enforcer.py index ff705e9f3..74d0102d0 100644 --- a/doc/source/enforcer.py +++ b/doc/source/enforcer.py @@ -117,17 +117,20 @@ def build_finished(app, exception): # TEMPORARY: Ignore the wait_for names when determining what is missing. app.info("ENFORCER: Ignoring wait_for_* names...") - missing = set(itertools.ifilterfalse(is_ignored, missing)) + missing = set(itertools.filterfalse(is_ignored, missing)) missing_count = len(missing) app.info("ENFORCER: Found %d missing proxy methods " "in the output" % missing_count) - # TODO(shade) Remove the if DEBUG once the build-openstack-sphinx-docs - # has been updated to use sphinx-build. - if DEBUG: - for name in sorted(missing): - app.info("ENFORCER: %s was not included in the output" % name) + # TODO(shade) This is spewing a bunch of content for missing thing that + # are not actually missing. Leave it as info rather than warn so that the + # gate doesn't break ... but we should figure out why this is broken and + # fix it. + # We also need to deal with Proxy subclassing keystoneauth.adapter.Adapter + # now - some of the warnings come from Adapter elements. + for name in sorted(missing): + app.info("ENFORCER: %s was not included in the output" % name) if app.config.enforcer_warnings_as_errors and missing_count > 0: raise EnforcementError( diff --git a/test-requirements.txt b/test-requirements.txt index d77c48500..943a8376e 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -3,20 +3,15 @@ # process, which may cause wedges in the gate later. hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0 -beautifulsoup4>=4.6.0 # MIT coverage!=4.4,>=4.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0 -docutils>=0.11 # OSI-Approved Open Source, Public Domain extras>=1.0.0 # MIT fixtures>=3.0.0 # Apache-2.0/BSD jsonschema<3.0.0,>=2.6.0 # MIT mock>=2.0.0 # BSD python-subunit>=1.0.0 # Apache-2.0/BSD -openstackdocstheme>=1.17.0 # Apache-2.0 oslotest>=1.10.0 # Apache-2.0 -reno>=2.5.0 # Apache-2.0 requests-mock>=1.1.0 # Apache-2.0 -sphinx>=1.6.2 # BSD stestr>=1.0.0 # Apache-2.0 testrepository>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD diff --git a/tox.ini b/tox.ini index 71440c949..46b0ff93a 100644 --- a/tox.ini +++ b/tox.ini @@ -30,6 +30,11 @@ commands = stestr --test-path ./openstack/tests/functional run --serial {posargs stestr slowest [testenv:pep8] +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} + -r{toxinidir}/requirements.txt + -r{toxinidir}/test-requirements.txt + -r{toxinidir}/doc/requirements.txt commands = doc8 doc/source flake8 @@ -60,11 +65,12 @@ passenv = HOME USER commands = {toxinidir}/extras/run-ansible-tests.sh -e {envdir} {posargs} [testenv:docs] -skip_install = True +basepython = python3 deps = -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} - -r{toxinidir}/test-requirements.txt -commands = sphinx-build -b html doc/source/ doc/build + -r{toxinidir}/requirements.txt + -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -W -d doc/build/doctrees -b html doc/source/ doc/build/html [testenv:releasenotes] commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html