From 59ad6e435adf2c8d9d08aede0dae59f11f1be783 Mon Sep 17 00:00:00 2001
From: "James E. Blair" <jeblair@redhat.com>
Date: Wed, 27 Sep 2017 15:08:10 -0700
Subject: [PATCH] Expand docs for fetch-sphinx-output role

Change-Id: I05e36a96dd4e8d030d070423158e329d0fb84fb6
---
 roles/fetch-sphinx-output/README.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/roles/fetch-sphinx-output/README.rst b/roles/fetch-sphinx-output/README.rst
index bdcf25911..d73ee3f2f 100644
--- a/roles/fetch-sphinx-output/README.rst
+++ b/roles/fetch-sphinx-output/README.rst
@@ -1 +1,19 @@
 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.