Follow the new PTI for document build

For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I444cdaad0d83d9d8795dc03793aefe2fa3a51203
This commit is contained in:
xywang 2018-04-20 10:03:48 +08:00 committed by Xiyuan Wang
parent 1bf597938d
commit 17ef71a482
4 changed files with 13 additions and 13 deletions

10
doc/requirements.txt Normal file
View File

@ -0,0 +1,10 @@
# 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.
openstackdocstheme>=1.18.1 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
sphinxcontrib-apidoc>=0.2.0 # BSD
reno>=2.5.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
pymongo!=3.1,>=3.0.2 # Apache-2.0
redis>=2.10.0 # MIT

View File

@ -21,12 +21,6 @@ classifier =
packages = packages =
zaqar zaqar
[build_sphinx]
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[entry_points] [entry_points]
console_scripts = console_scripts =
zaqar-bench = zaqar.bench.conductor:main zaqar-bench = zaqar.bench.conductor:main

View File

@ -26,13 +26,7 @@ testtools>=2.2.0 # MIT
oslo.db>=4.27.0 # Apache-2.0 oslo.db>=4.27.0 # Apache-2.0
testresources>=2.0.0 # Apache-2.0/BSD testresources>=2.0.0 # Apache-2.0/BSD
os-testr>=1.0.0 # Apache-2.0 os-testr>=1.0.0 # Apache-2.0
# Documentation
sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
openstackdocstheme>=1.18.1 # Apache-2.0
oslotest>=3.2.0 # Apache-2.0 oslotest>=3.2.0 # Apache-2.0
reno>=2.5.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
#OSprofiler #OSprofiler
osprofiler>=1.4.0 # Apache-2.0 osprofiler>=1.4.0 # Apache-2.0

View File

@ -44,9 +44,11 @@ commands =
commands = {posargs} commands = {posargs}
[testenv:docs] [testenv:docs]
deps =
-r{toxinidir}/doc/requirements.txt
commands = commands =
doc8 doc/source doc8 doc/source
python setup.py build_sphinx
sphinx-build -W -b html api-ref/source api-ref/build/html sphinx-build -W -b html api-ref/source api-ref/build/html
[testenv:api-ref] [testenv:api-ref]