zuul/zuul-jobs
Code Issues Proposed changes

Expand docs for fetch-sphinx-output role

Browse Source 
Change-Id: I05e36a96dd4e8d030d070423158e329d0fb84fb6
This commit is contained in:
James E. Blair 2017-09-27 15:08:10 -07:00
parent 38a46bcf21
commit 59ad6e435a
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
roles/fetch-sphinx-output/README.rst
View File

@ -1 +1,19 @@
Collect output from a sphinx build 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.