Fetch generated PDF files correctly

PDF files from openstackdocsstheme-tox-manuals-buildpdf(-starlingxpdf)
jobs were not fetched after recent changes in the related zuul jobs.
This commit merges 'buildpdf' tox env into the 'docs' tox env
following the OpenStack PDF community goal convention.
The same change is made for starlingxdocs theme.
The .zuul.yaml file is updated accordingly.

Change-Id: I0081f77a19b71b093b3debf91e85a42cf2053471
This commit is contained in:
Akihiro Motoki 2019-09-18 06:40:08 +09:00
parent 7aaba6f9f5
commit 3e97737e5a
3 changed files with 17 additions and 41 deletions

View File

@ -1,21 +1,9 @@
# parent job is defined in openstack-manuals
- job:
name: openstackdocsstheme-tox-manuals-buildpdf
parent: build-tox-manuals-base
vars:
tox_envlist: buildpdf
- job:
name: openstackdocsstheme-tox-manuals-buildpdf-starlingxpdf
parent: build-tox-manuals-base
vars:
tox_envlist: buildpdf-starlingxdocs
- job: - job:
name: openstack-tox-docs-starlingxdocs name: openstack-tox-docs-starlingxdocs
parent: openstack-tox-docs parent: openstack-tox-docs
vars: vars:
tox_envlist: docs-starlingxdocs tox_envlist: docs-starlingxdocs
tox_pdf_envlist: pdf-docs-starlingxdocs
- project: - project:
templates: templates:
@ -24,8 +12,6 @@
- release-notes-jobs-python3 - release-notes-jobs-python3
check: check:
jobs: jobs:
- openstackdocsstheme-tox-manuals-buildpdf
- openstackdocsstheme-tox-manuals-buildpdf-starlingxpdf
- openstack-tox-pep8 - openstack-tox-pep8
- build-openstack-api-ref: - build-openstack-api-ref:
# Override files section of the job so that this builds # Override files section of the job so that this builds
@ -41,8 +27,6 @@
- openstack-tox-docs-starlingxdocs - openstack-tox-docs-starlingxdocs
gate: gate:
jobs: jobs:
- openstackdocsstheme-tox-manuals-buildpdf
- openstackdocsstheme-tox-manuals-buildpdf-starlingxpdf
- openstack-tox-pep8 - openstack-tox-pep8
- build-openstack-api-ref: - build-openstack-api-ref:
files: files:

View File

@ -62,6 +62,7 @@ html_static_path = ['_static/css']
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
('index', 'os-doc-demo.tex', u'os-doc-demo Documentation', ('index', 'doc-openstackdocstheme.tex',
u'OpenStack Docs Theme Documentation',
u'OpenStack Contributors', 'manual'), u'OpenStack Contributors', 'manual'),
] ]

37
tox.ini
View File

@ -27,18 +27,19 @@ commands = {posargs}
[testenv:docs] [testenv:docs]
basepython = python3 basepython = python3
commands = commands =
rm -rf doc/build api-ref/build rm -rf doc/build/html doc/build/doctrees
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
[testenv:docs-starlingxdocs] [testenv:docs-starlingxdocs]
basepython = python3 basepython = python3
envdir = {toxworkdir}/docs
commands = commands =
rm -rf doc/build api-ref/build rm -rf doc/build/html doc/build/doctrees
sphinx-build -a -E -W -d doc/build/doctrees -b html -D html_theme=starlingxdocs doc/source doc/build/html sphinx-build -a -E -W -d doc/build/doctrees -b html -D html_theme=starlingxdocs doc/source doc/build/html
[testenv:html] [testenv:html]
commands = commands =
rm -rf doc/build api-ref/build rm -rf doc/build/html doc/build/doctrees api-ref/build
sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html
sphinx-build -a -E -W -d api-ref/build/doctrees -b html api-ref/source api-ref/build/html sphinx-build -a -E -W -d api-ref/build/doctrees -b html api-ref/source api-ref/build/html
@ -66,31 +67,21 @@ commands =
rm -rf api-ref/build rm -rf api-ref/build
sphinx-build -a -E -W -d api-ref/build/doctrees -b html -D html_theme=starlingxdocs api-ref/source api-ref/build/html sphinx-build -a -E -W -d api-ref/build/doctrees -b html -D html_theme=starlingxdocs api-ref/source api-ref/build/html
[testenv:buildpdf] [testenv:pdf-docs]
# Only build PDF and push it to publish-docs folder so that OpenStack basepython = python3
# CI jobs will publish it. envdir = {toxworkdir}/docs
whitelist_externals =
make
cp
mkdir
commands = commands =
sphinx-build -a -E -W -d doc/build/doctrees -b latex doc/source doc/build/pdf rm -rf doc/build/pdf
sphinx-build -a -E -W -b latex doc/source doc/build/pdf
make -C doc/build/pdf make -C doc/build/pdf
mkdir -p publish-docs
cp doc/build/pdf/os-doc-demo.pdf publish-docs
[testenv:buildpdf-starlingxdocs] [testenv:pdf-docs-starlingxdocs]
# Only build PDF and push it to publish-docs folder so that OpenStack basepython = python3
# CI jobs will publish it. envdir = {toxworkdir}/docs
whitelist_externals =
make
cp
mkdir
commands = commands =
sphinx-build -a -E -W -d doc/build/doctrees -b latex -D html_theme=starlingxdocs doc/source doc/build/pdf rm -rf doc/build/pdf
sphinx-build -a -E -W -b latex -D html_theme=starlingxdocs doc/source doc/build/pdf
make -C doc/build/pdf make -C doc/build/pdf
mkdir -p publish-docs
cp doc/build/pdf/os-doc-demo.pdf publish-docs
[testenv:bindep] [testenv:bindep]
# Do not install any requirements. We want this to be fast and work even if # Do not install any requirements. We want this to be fast and work even if