James E. Blair 59ad6e435a Expand docs for fetch-sphinx-output role
Change-Id: I05e36a96dd4e8d030d070423158e329d0fb84fb6
2017-09-27 15:08:49 -07:00

20 lines
567 B
ReStructuredText

Collect output from a sphinx build
By default, this copies the output from the sphinx build on the worker
to the log root of the executor.
**Role Variables**
.. zuul:rolevar:: zuul_executor_dest
:default: {{ zuul.executor.log_root }}
The destination directory on the executor. By default, the log
root.
.. zuul:rolevar:: sphinx_output_src
:default: src/{{ zuul.project.canonical_name }}/doc/build/html
The location on the worker from which to fetch the generated sphinx
content. By default, the HTML doc build dir of the current
project.