diff options
author | Nguyen Hai <nguyentrihai93@gmail.com> | 2018-03-16 01:35:19 +0900 |
---|---|---|
committer | Nguyen Hai <nguyentrihai93@gmail.com> | 2018-04-06 14:33:47 +0000 |
commit | 7ba42e091dad82b134f3acf73c72edccaca84830 (patch) | |
tree | 0cda91605e5bc22a46b343e69d32603af14445c6 /tox.ini | |
parent | f5605d13e67c71c46538bafa5f7ddc18fb7427a6 (diff) | |
download | ironic-7ba42e091dad82b134f3acf73c72edccaca84830.tar.gz |
Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
[doc/requirements.txt] & [test-requirements.txt]
To support documentation generation in new PTI, project should have
list python dependencies needed for documentation in
doc/requirements.txt which are move from test-requirements.txt
[doc/source/contributor/index.rst] & [setup.cfg]
- Remove [pbr] section in setup.cfg [3], and unrelated lines in
contributor/index.rst
[3] http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html
- Add sphinxcontrib.apidoc to replace pbr autodoc
[tox.ini]
--ignore D000: pep8 require sphinx (which move to doc/requirements.txt)
to test doc/source files, however, docs already test the doc/source.
Therefore we can ignore the D000 error code.
Depends-On: https://review.openstack.org/#/c/559327/
Change-Id: Iee90f19a5e46978a97035eab7e4b1e0ec68b8684
Diffstat (limited to 'tox.ini')
-rw-r--r-- | tox.ini | 24 |
1 files changed, 14 insertions, 10 deletions
@@ -35,7 +35,7 @@ commands = # the check and gate queues. {toxinidir}/tools/run_bashate.sh {toxinidir} # Check the *.rst files - doc8 README.rst CONTRIBUTING.rst doc/source --ignore D001 + doc8 README.rst CONTRIBUTING.rst doc/source --ignore D001 --ignore D000 # Check to make sure reno releasenotes created with 'reno new' {toxinidir}/tools/check-releasenotes.py @@ -72,23 +72,27 @@ commands = commands = oslo_debug_helper -t ironic/tests/unit {posargs} [testenv:docs] -# FIXME(dtantsur): workaround for bug #1714025 -basepython = python2 -setenv = PYTHONHASHSEED=0 -sitepackages = False -envdir = {toxworkdir}/venv -commands = - python setup.py build_sphinx +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} + -r{toxinidir}/requirements.txt + -r{toxinidir}/doc/requirements.txt +commands = sphinx-build -W -b html doc/source doc/build/html [testenv:api-ref] -# This environment is called from CI scripts to test and publish -# the API Ref to developer.openstack.org. +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} + -r{toxinidir}/requirements.txt + -r{toxinidir}/doc/requirements.txt whitelist_externals = bash commands = bash -c 'rm -rf api-ref/build' sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html [testenv:releasenotes] +deps = + -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} + -r{toxinidir}/requirements.txt + -r{toxinidir}/doc/requirements.txt commands = sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html |