openstack-zuul-jobs/roles/prepare-build-pdf-docs/README.rst
Akihiro Motoki bba1a617ee Add support for building PDFs
We want PDFs. We don't want to have to go to each project and add a
'pdf' tox target or similar. Get the former and avoid the latter by
adding a step to build our PDFs to the 'openstack-tox-docs' job.

The job assumes a 'pdf-docs' tox env to build PDF docs.
If 'pdf-docs' tox env does not exist, PDF doc build will be skipped.

Note that only the job for master and stein is updated,
we do not build PDFs for older releases.

Do not build PDFs for deploy-guide for now.

Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
Co-Authored-By: Andreas Jaeger <aj@suse.com>
Depends-On: https://review.opendev.org/678077
Change-Id: Ibc455ba511a877159848f4060a6058800d7d2f9b
2019-08-23 17:29:58 +02:00

21 lines
513 B
ReStructuredText

Install Packages for build-pdf-docs
Install binary packages for :zuul:role:`build-pdf-docs`.
This role currently only supports Ubuntu Bionic.
If the tox environment specified in `tox_pdf_envlist`
does not exist, package installation will be skipped.
**Role Variables**
.. zuul:rolevar:: tox_pdf_envlist
:default: pdf-docs
The tox environment used for PDF doc building.
.. zuul:rolevar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
The location of the main working directory of the job.