openstack-zuul-jobs/roles/write-root-marker/README.rst
Monty Taylor 35a773a863 Make AFS marker roles honor sphinx variables
We set a sphinx_build_dir already on jobs. Make write-root-marker,
prepare-docs-for-afs and prepare-infra-docs-for-afs honor it by default.

Change-Id: I7c3d578a00a4aa4c9e175f5f83e3171c6f6a4a61
2017-12-20 06:26:05 +00:00

20 lines
495 B
ReStructuredText

Write the root marker for an AFS publishing job
** Role Variables **
.. zuul:rolevar:: sphinx_build_dir
:default: doc/build
Directory relative to zuul_work_dir where Sphinx build output was put.
.. zuul:rolevar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
Directory to operate in.
.. zuul:rolevar:: root_marker_dir
:default: {{ zuul_work_dir }}/{{ sphinx_build_dir }}/html
The documentation build directory. The marker file will be placed
in this directory.