Browse Source

switch documentation job to new PTI

Update .zuul.yaml to use PTI job, update tox.ini to use the common way
to run sphinx, update setup.cfg for handling warnings as errors.

Add new docs target to tox.ini and make it default target, the target is
needed by CI scripts.

Note that ossa does not work with python3, so the docs environment does
not use basepython. This needs a rework of doc/source/_exts/vmt.py.

Change-Id: I7196aab97167d857f0afdfe005d74c7f0f8f1073
Andreas Jaeger 5 months ago
parent
commit
eeee9fddd2
3 changed files with 10 additions and 3 deletions
  1. 1
    1
      .zuul.yaml
  2. 1
    0
      setup.cfg
  3. 8
    2
      tox.ini

+ 1
- 1
.zuul.yaml View File

@@ -1,6 +1,6 @@
1 1
 - project:
2 2
     templates:
3
-      - build-openstack-sphinx-docs
3
+      - build-openstack-docs-pti
4 4
     post:
5 5
       jobs:
6 6
         - publish-security

+ 1
- 0
setup.cfg View File

@@ -12,6 +12,7 @@ home-page = http://www.openstack.org/
12 12
 all_files = 1
13 13
 build-dir = doc/build
14 14
 source-dir = doc/source
15
+warning-is-error = 1
15 16
 
16 17
 [pbr]
17 18
 warnerrors = True

+ 8
- 2
tox.ini View File

@@ -1,5 +1,5 @@
1 1
 [tox]
2
-envlist = venv
2
+envlist = docs
3 3
 minversion = 1.6
4 4
 skipsdist = True
5 5
 
@@ -8,7 +8,13 @@ usedevelop = True
8 8
 install_command = pip install -U {opts} {packages}
9 9
 setenv = VIRTUAL_ENV={envdir}
10 10
 
11
+[testenv:docs]
12
+# The repo does not work with python3 yet, so no basepypthon set
13
+# to python3.
14
+deps = -r{toxinidir}/test-requirements.txt
15
+commands = sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
16
+
11 17
 [testenv:venv]
12 18
 basepython = python3
13 19
 deps = -r{toxinidir}/test-requirements.txt
14
-commands =python setup.py build_sphinx
20
+commands = {[testenv:docs]commands}

Loading…
Cancel
Save