zuul-jobs/roles/fetch-sphinx-tarball/README.rst
Andreas Jaeger 0ca632b19d Switch PDF file name to doc-PROJECT.pdf
Further work on the PDF generation showed that many projects have
project logos as svg files with the name PROJECT.svg, those get
converted to PROJECT.pdf and collide with the default name used here.

Change the default to "doc-PROJECT.pdf" to have a unique name.

This is a change in the default but we only added this 11 days ago, so
I hope it's fine to change.

Change-Id: I4f2224633fd4edbc3121af53d0202796cf8a0a60
2019-09-03 14:40:39 +02:00

26 lines
714 B
ReStructuredText

Collect output from a sphinx build as a tarball
By default, this copies the output from the sphinx build on the worker
to the log root of the executor as a tarball, and then extracts the
archive into the log root for viewing.
**Role Variables**
.. zuul:rolevar:: sphinx_build_dir
:default: doc/build
Directory relative to zuul_work_dir where build output should be
found.
.. zuul:rolevar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
The location of the main working directory of the job.
.. zuul:rolevar:: sphinx_pdf_files
:default: list
A list of file names of PDF files to collect.
By default, the list contains as entry only
``doc-{{ zuul.project.short_name }}.pdf``.