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: I3eb92c968ece3c15eeae59bb6ef9492f3d03eeed
tags/5.1.0
Nguyen Van Trung 1 year ago
parent
commit
460a8f6be3
4 changed files with 14 additions and 13 deletions
  1. 6
    0
      doc/requirements.txt
  2. 0
    9
      setup.cfg
  3. 0
    3
      test-requirements.txt
  4. 8
    1
      tox.ini

+ 6
- 0
doc/requirements.txt View File

@@ -0,0 +1,6 @@
1
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
2
+sphinxcontrib-httpdomain>=1.3.0 # BSD
3
+sphinxcontrib-blockdiag>=1.5.4 # BSD
4
+reno>=2.5.0 # Apache-2.0
5
+os-api-ref>=1.4.0 # Apache-2.0
6
+openstackdocstheme>=1.18.1 # Apache-2.0

+ 0
- 9
setup.cfg View File

@@ -26,15 +26,6 @@ console_scripts =
26 26
     bifrost_inventory.py = bifrost.inventory:main
27 27
     bifrost_inventory = bifrost.inventory:main
28 28
 
29
-[build_sphinx]
30
-source-dir = doc/source
31
-build-dir = doc/build
32
-all_files = 1
33
-warning-is-error = 1
34
-
35
-[upload_sphinx]
36
-upload-dir = doc/build/html
37
-
38 29
 [compile_catalog]
39 30
 directory = bifrost/locale
40 31
 domain = bifrost

+ 0
- 3
test-requirements.txt View File

@@ -6,9 +6,6 @@ hacking!=0.13.0,<0.14,>=0.12.0 # Apache-2.0
6 6
 
7 7
 coverage!=4.4,>=4.0 # Apache-2.0
8 8
 doc8>=0.6.0 # Apache-2.0
9
-reno>=2.5.0 # Apache-2.0
10
-sphinx!=1.6.6,!=1.6.7,>=1.6.5 # BSD
11
-openstackdocstheme>=1.18.1 # Apache-2.0
12 9
 oslotest>=3.2.0 # Apache-2.0
13 10
 testrepository>=0.0.18 # Apache-2.0/BSD
14 11
 testscenarios>=0.4 # Apache-2.0/BSD

+ 8
- 1
tox.ini View File

@@ -20,6 +20,9 @@ commands = flake8
20 20
 
21 21
 [testenv:venv]
22 22
 basepython = python3
23
+deps =
24
+  -r{toxinidir}/test-requirements.txt
25
+  -r{toxinidir}/doc/requirements.txt
23 26
 commands = {posargs}
24 27
 
25 28
 [testenv:cover]
@@ -28,7 +31,11 @@ commands = python setup.py test --coverage --testr-args='{posargs}'
28 31
 
29 32
 [testenv:docs]
30 33
 basepython = python3
31
-commands = python setup.py build_sphinx
34
+deps =
35
+  -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
36
+  -r{toxinidir}/requirements.txt
37
+  -r{toxinidir}/doc/requirements.txt
38
+commands = sphinx-build -W -b html doc/source doc/build/html
32 39
 
33 40
 [testenv:debug]
34 41
 basepython = python3

Loading…
Cancel
Save