Browse Source

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: I12655940f683caec7cc0708a42ddf52720de6dbe
tags/18.0.0.0b1
melissaml 1 year ago
parent
commit
80bee99f27
3 changed files with 14 additions and 10 deletions
  1. 11
    0
      doc/requirements.txt
  2. 0
    8
      test-requirements.txt
  3. 3
    2
      tox.ini

+ 11
- 0
doc/requirements.txt View File

@@ -0,0 +1,11 @@
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
6
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
7
+oslosphinx>=4.7.0 # Apache-2.0
8
+openstackdocstheme>=1.18.1 # Apache-2.0
9
+doc8>=0.6.0 # Apache-2.0
10
+reno>=2.5.0 # Apache-2.0
11
+sphinxmark>=0.1.14 # Apache-2.0

+ 0
- 8
test-requirements.txt View File

@@ -7,11 +7,3 @@ pyasn1!=0.2.3,>=0.1.8 # BSD
7 7
 pyOpenSSL>=17.1.0 # Apache-2.0
8 8
 requests>=2.14.2 # Apache-2.0
9 9
 ndg-httpsclient>=0.4.2;python_version<'3.0' # BSD
10
-
11
-# this is required for the docs build jobs
12
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
13
-oslosphinx>=4.7.0 # Apache-2.0
14
-openstackdocstheme>=1.18.1 # Apache-2.0
15
-doc8>=0.6.0 # Apache-2.0
16
-reno>=2.5.0 # Apache-2.0
17
-sphinxmark>=0.1.14 # Apache-2.0

+ 3
- 2
tox.ini View File

@@ -32,10 +32,11 @@ setenv =
32 32
 
33 33
 
34 34
 [testenv:docs]
35
+deps = -r{toxinidir}/doc/requirements.txt
35 36
 commands=
36 37
     bash -c "rm -rf doc/build"
37 38
     doc8 doc
38
-    python setup.py build_sphinx
39
+    sphinx-build -b html doc/source doc/build/html
39 40
 
40 41
 
41 42
 [doc8]
@@ -44,6 +45,7 @@ extensions = .rst
44 45
 
45 46
 
46 47
 [testenv:releasenotes]
48
+deps = -r{toxinidir}/doc/requirements.txt
47 49
 commands =
48 50
     sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
49 51
 
@@ -112,4 +114,3 @@ commands =
112 114
     {[testenv:bashate]commands}
113 115
     {[testenv:ansible-lint]commands}
114 116
     {[testenv:ansible-syntax]commands}
115
-    {[testenv:docs]commands}

Loading…
Cancel
Save