openstack
/
cyborg
Code Issues Proposed changes

Follow the new PTI for document build 

In order to follow the new PTI for doc build, this patch:
1)removes unused build_sphinx in setup.cfg
2)move doc dependencies from test-requirements.txt to doc/requirements.txt
3)update tox.ini

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

Change-Id: Ic700f04b857516ce5b25ce5e0fc431d1f08e24f3
This commit is contained in:
Yumeng Bao 2018-08-10 16:53:34 +08:00
parent b727c1670a
commit 33b86b8631
4 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/requirements.txt Normal file
View File

@ -0,0 +1,7 @@
sphinx>=1.6.2,!=1.6.6,!=1.6.7 # BSD
sphinxcontrib-httpdomain>=1.3.0 # BSD
sphinxcontrib-pecanwsme>=0.2 # Apache-2.0
sphinxcontrib-seqdiag>=0.8.4 # BSD
reno>=2.5.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
openstackdocstheme>=1.19.0 # Apache-2.0

9
setup.cfg
View File

@ -45,15 +45,6 @@ cyborg.database.migration_backend =
oslo.config.opts =
cyborg = cyborg.conf.opts:list_opts
[build_sphinx]
source-dir = doc/source
build-dir = doc/build
all_files = 1
warning-is-error = 1
[upload_sphinx]
upload-dir = doc/build/html
[compile_catalog]
directory = cyborg/locale
domain = cyborg

6
test-requirements.txt
View File

@ -7,16 +7,12 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
coverage>=3.6,!=4.4 # Apache-2.0
fixtures>=3.0.0 # Apache-2.0/BSD
mock>=2.0.0 # BSD
sphinx>=1.6.2,!=1.6.6,!=1.6.7 # BSD
ddt>=1.0.1 # MIT
oslotest>=3.2.0 # Apache-2.0
stestr>=2.0.0 # Apache-2.0/BSD
testresources>=2.0.0 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD
testtools>=0.9.32 # MIT
sphinxcontrib-pecanwsme>=0.2 # Apache-2.0
sphinxcontrib-seqdiag>=0.8.4 # BSD
reno>=1.8.0 # Apache-2.0
os-api-ref>=1.4.0 # Apache-2.0
tempest>=17.1.0 # Apache-2.0
doc8>=0.6.0 # Apache-2.0
Pygments>=2.2.0 # BSD license

5
tox.ini
View File

@ -63,12 +63,13 @@ ignore-path = .venv,.git,.tox,*cyborg/locale*,*lib/python*,*cyborg.egg*,api-ref/
[testenv:docs]
basepython = python3
deps = -r{toxinidir}/doc/requirements.txt
commands =
sphinx-build -b html doc/source doc/build/html
oslo-config-generator --config-file=tools/config/cyborg-config-generator.conf
sphinx-build -W -b html doc/source doc/build/html
[testenv:releasenotes]
basepython = python3
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -a -W -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
[testenv:debug]