Browse Source

Follow the new PTI for document build

For compliance with the Project Testing Interface as
described in [1]:
[1] https://governance.openstack.org/tc/reference/project-testing-interface.html
For more detials information, please refer to [2]:
[2] http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I1fe5352e8e4a7703bd9908e7221f04110163d6fb
tags/6.0.0.0b3
junboli 1 year ago
parent
commit
a60daf4f60
3 changed files with 23 additions and 7 deletions
  1. 12
    0
      doc/requirements.txt
  2. 0
    4
      test-requirements.txt
  3. 11
    3
      tox.ini

+ 12
- 0
doc/requirements.txt View File

@@ -0,0 +1,12 @@
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
+openstackdocstheme>=1.17.0 # Apache-2.0
5
+reno>=2.5.0 # Apache-2.0
6
+doc8>=0.6.0 # Apache-2.0
7
+sphinx>=1.6.2 # BSD
8
+mock>=2.0.0 # BSD
9
+os-api-ref>=1.4.0 # Apache-2.0
10
+ddt>=1.0.1 # MIT
11
+fixtures>=3.0.0 # Apache-2.0/BSD
12
+oslotest>=3.2.0 # Apache-2.0

+ 0
- 4
test-requirements.txt View File

@@ -12,7 +12,6 @@ fixtures>=3.0.0 # Apache-2.0/BSD
12 12
 mock>=2.0.0 # BSD
13 13
 iso8601>=0.1.11 # MIT
14 14
 oslotest>=3.2.0 # Apache-2.0
15
-openstackdocstheme>=1.17.0 # Apache-2.0
16 15
 
17 16
 # Do not remove 'PyMySQL' and 'psycopg2' dependencies. They are used
18 17
 # by oslo_db lib for running MySQL and PostgreSQL DB migration tests.
@@ -21,11 +20,8 @@ PyMySQL>=0.7.6 # MIT License
21 20
 psycopg2>=2.6.2 # LGPL/ZPL
22 21
 
23 22
 requests-mock>=1.1.0 # Apache-2.0
24
-sphinx>=1.6.2 # BSD
25 23
 os-api-ref>=1.4.0 # Apache-2.0
26 24
 os-testr>=1.0.0 # Apache-2.0
27 25
 testresources>=2.0.0 # Apache-2.0/BSD
28 26
 testscenarios>=0.4 # Apache-2.0/BSD
29 27
 testtools>=2.2.0 # MIT
30
-reno>=2.5.0 # Apache-2.0
31
-doc8>=0.6.0 # Apache-2.0

+ 11
- 3
tox.ini View File

@@ -15,11 +15,15 @@ commands =
15 15
   ostestr {posargs}
16 16
 
17 17
 [testenv:releasenotes]
18
-whitelist_externals = rm
18
+deps =
19
+  -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
20
+  -r{toxinidir}/requirements.txt
21
+  -r{toxinidir}/doc/requirements.txt
19 22
 commands =
20 23
   rm -rf releasenotes/build
21 24
   sphinx-build -a -E -W -d releasenotes/build/doctrees \
22 25
          -b html releasenotes/source releasenotes/build/html
26
+whitelist_externals = rm
23 27
 
24 28
 [testenv:debug]
25 29
 commands = oslo_debug_helper {posargs}
@@ -64,12 +68,16 @@ commands = oslopolicy-sample-generator --config-file=etc/manila/manila-policy-ge
64 68
 commands = {posargs}
65 69
 
66 70
 [testenv:docs]
67
-whitelist_externals = rm
71
+deps =
72
+  -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
73
+  -r{toxinidir}/requirements.txt
74
+  -r{toxinidir}/doc/requirements.txt
68 75
 commands =
69 76
   rm -rf doc/build
70
-  python setup.py build_sphinx
77
+  sphinx-build -b html doc/source doc/build/html
71 78
   # Ignore D001 since we allow lines in excess of 79 characters.
72 79
   doc8 --ignore D001 --ignore-path .tox --ignore-path doc/build --ignore-path manila.egg-info -e txt -e rst
80
+whitelist_externals = rm
73 81
 
74 82
 [testenv:cover]
75 83
 setenv =

Loading…
Cancel
Save