diff --git a/roles/fetch-sphinx-output/README.rst b/roles/fetch-sphinx-output/README.rst index 6f658691e..3f84dd994 100644 --- a/roles/fetch-sphinx-output/README.rst +++ b/roles/fetch-sphinx-output/README.rst @@ -16,8 +16,15 @@ to the log root of the executor. Directory relative to zuul_work_dir where build output will be put. +.. zuul:rolevar:: sphinx_output_suffix + :default: '' + + Suffix to use for constructing the path. This is normally an + empty string. If set to '/' then, rsync will remove the last part + from the original path. + .. zuul:rolevar:: sphinx_output_src - :default: {{ zuul_work_dir }}/{{ sphinx_build_dir }}/html + :default: {{ zuul_work_dir }}/{{ sphinx_build_dir }}/html{{ sphinx_output_suffix }} The location on the worker from which to fetch the generated sphinx content. By default, the HTML doc build dir of the current diff --git a/roles/fetch-sphinx-output/defaults/main.yaml b/roles/fetch-sphinx-output/defaults/main.yaml index ca077c601..33c0a57e2 100644 --- a/roles/fetch-sphinx-output/defaults/main.yaml +++ b/roles/fetch-sphinx-output/defaults/main.yaml @@ -2,4 +2,5 @@ zuul_executor_dest: "{{ zuul.executor.log_root }}" zuul_work_dir: "{{ zuul.project.src_dir }}" sphinx_build_dir: doc/build -sphinx_output_src: "{{ zuul_work_dir }}/{{ sphinx_build_dir }}/html" +sphinx_output_suffix: "" +sphinx_output_src: "{{ zuul_work_dir }}/{{ sphinx_build_dir }}/html{{ sphinx_output_suffix }}"