summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZhongShengping <chdzsp@163.com>2018-03-09 10:46:39 +0800
committerZhongShengping <chdzsp@163.com>2018-03-09 12:01:26 +0800
commit95d6063c0237f5a2cf4e0520dbaa1d367bd83286 (patch)
tree5c9c2a4718e1d6e27d460a98ceb3b56f192a1ccd
parent91b0e26dd0624d6990d1542a69dafce6107a052a (diff)
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: I66c2cd22230d849cf8669bb768264c49d0e453b6
Notes
Notes (review): Code-Review+2: Jean-Philippe Evrard <jean-philippe@evrard.me> Code-Review+2: Markos Chandras (hwoarang) <mchandras@suse.de> Workflow+1: Markos Chandras (hwoarang) <mchandras@suse.de> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Fri, 09 Mar 2018 16:32:47 +0000 Reviewed-on: https://review.openstack.org/551141 Project: openstack/openstack-ansible-os_almanach Branch: refs/heads/master
-rw-r--r--doc/requirements.txt10
-rw-r--r--test-requirements.txt7
-rw-r--r--tox.ini5
3 files changed, 13 insertions, 9 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
new file mode 100644
index 0000000..7e68e1c
--- /dev/null
+++ b/doc/requirements.txt
@@ -0,0 +1,10 @@
1# The order of packages is significant, because pip processes them in the order
2# of appearance. Changing the order has an impact on the overall integration
3# process, which may cause wedges in the gate later.
4
5# this is required for the docs build jobs
6sphinx!=1.6.6,>=1.6.2 # BSD
7openstackdocstheme>=1.18.1 # Apache-2.0
8reno>=2.5.0 # Apache-2.0
9sphinxmark>=0.1.14 # Apache-2.0
10doc8>=0.6.0 # Apache-2.0
diff --git a/test-requirements.txt b/test-requirements.txt
index 09d54c4..2d59dc9 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -7,10 +7,3 @@ pyasn1!=0.2.3,>=0.1.8 # BSD
7pyOpenSSL>=16.2.0 # Apache-2.0 7pyOpenSSL>=16.2.0 # Apache-2.0
8requests>=2.14.2 # Apache-2.0 8requests>=2.14.2 # Apache-2.0
9ndg-httpsclient>=0.4.2;python_version<'3.0' # BSD 9ndg-httpsclient>=0.4.2;python_version<'3.0' # BSD
10
11# this is required for the docs build jobs
12sphinx!=1.6.6,>=1.6.2 # BSD
13openstackdocstheme>=1.18.1 # Apache-2.0
14doc8>=0.6.0 # Apache-2.0
15reno>=2.5.0 # Apache-2.0
16sphinxmark>=0.1.14 # Apache-2.0
diff --git a/tox.ini b/tox.ini
index 8106b98..c6cf930 100644
--- a/tox.ini
+++ b/tox.ini
@@ -31,10 +31,11 @@ setenv =
31 31
32 32
33[testenv:docs] 33[testenv:docs]
34deps = -r{toxinidir}/doc/requirements.txt
34commands= 35commands=
35 bash -c "rm -rf doc/build" 36 bash -c "rm -rf doc/build"
36 doc8 doc 37 doc8 doc
37 python setup.py build_sphinx 38 sphinx-build -b html doc/source doc/build/html
38 39
39 40
40[doc8] 41[doc8]
@@ -43,6 +44,7 @@ extensions = .rst
43 44
44 45
45[testenv:releasenotes] 46[testenv:releasenotes]
47deps = -r{toxinidir}/doc/requirements.txt
46commands = 48commands =
47 sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html 49 sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
48 50
@@ -112,4 +114,3 @@ commands =
112 {[testenv:bashate]commands} 114 {[testenv:bashate]commands}
113 {[testenv:ansible-lint]commands} 115 {[testenv:ansible-lint]commands}
114 {[testenv:ansible-syntax]commands} 116 {[testenv:ansible-syntax]commands}
115 {[testenv:docs]commands}