openstack/swift
Code Issues Proposed changes

Follow the new PTI for document build

Browse Source 
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
For more details information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html
http://lists.openstack.org/pipermail/openstack-dev/2018-March/128594.html

Co-Authored-By: Nguyen Hai <nguyentrihai93@gmail.com>
Change-Id: I26dc41c7df57bf79db531c6e67e148e01c17e992
This commit is contained in:
wangqi 2018-03-11 16:27:28 +00:00 committed by Nguyen Hai
parent 744d6b6ab3
commit a027f2c105
4 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/requirements.txt Normal file
View File

@ -0,0 +1,8 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
# this is required for the docs build jobs
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
reno>=1.8.0 # Apache-2.0
os-api-ref>=1.0.0 # Apache-2.0

5
setup.cfg
View File

@ -111,11 +111,6 @@ paste.filter_factory =
listing_formats = swift.common.middleware.listing_formats:filter_factory listing_formats = swift.common.middleware.listing_formats:filter_factory
symlink = swift.common.middleware.symlink:filter_factory symlink = swift.common.middleware.symlink:filter_factory
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[egg_info] [egg_info]
tag_build = tag_build =

4
test-requirements.txt
View File

@ -8,14 +8,10 @@ coverage>=3.6 # Apache-2.0
nose # LGPL nose # LGPL
nosexcover # BSD nosexcover # BSD
nosehtmloutput>=0.0.3 # Apache-2.0 nosehtmloutput>=0.0.3 # Apache-2.0
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
os-api-ref>=1.0.0 # Apache-2.0
os-testr>=0.8.0 # Apache-2.0 os-testr>=0.8.0 # Apache-2.0
mock>=2.0 # BSD mock>=2.0 # BSD
python-swiftclient python-swiftclient
python-keystoneclient!=2.1.0,>=2.0.0 # Apache-2.0 python-keystoneclient!=2.1.0,>=2.0.0 # Apache-2.0
reno>=1.8.0 # Apache-2.0
# Security checks # Security checks
bandit>=1.1.0 # Apache-2.0 bandit>=1.1.0 # Apache-2.0

8
tox.ini
View File

@ -92,15 +92,14 @@ commands = {posargs}
[testenv:docs] [testenv:docs]
basepython = python2.7 basepython = python2.7
commands = python setup.py build_sphinx deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -W -b html doc/source doc/build/html
[testenv:api-ref] [testenv:api-ref]
# This environment is called from CI scripts to test and publish # This environment is called from CI scripts to test and publish
# the API Ref to developer.openstack.org. # the API Ref to developer.openstack.org.
# we do not use -W here because we are doing some slightly tricky
# things to build a single page document, and as such, we are ok
# ignoring the duplicate stanzas warning.
basepython = python2.7 basepython = python2.7
deps = -r{toxinidir}/doc/requirements.txt
commands = commands =
rm -rf api-ref/build rm -rf api-ref/build
sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html
@ -132,4 +131,5 @@ deps = bindep
commands = bindep test commands = bindep test
[testenv:releasenotes] [testenv:releasenotes]
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html