zuul/zuul-jobs
Code Issues Proposed changes
14a409be73
zuul-jobs/roles/fetch-sphinx-tarball
History
Andreas Jaeger 5eb4c257f5 fetch-sphinx: Exclude doctrees directory 
The sphinx .doctrees directory is not needed for publishing. By default
sphinx puts it below html. Some projects add to sphinx-build a "-d"
option to put the content elsewhere and not publish it.

This change assures that a .doctrees directory below "html" will not put
stored as artifact and published later.

Statistics: In all of OpenDev, we have:
* 511 repos putting .doctrees elsewhere and thus not publishing it
* 631 repos  no caring and thus publishing .doctrees

The size of .doctrees directory is not neglectable: 2MB for
system-config, 14 MB for nova.

Change-Id: I63b581164aab84352d9e80278cf4a8d634ff28af
2020-01-21 08:32:26 +01:00
..
defaults Switch PDF file name to doc-PROJECT.pdf 2019-09-03 14:40:39 +02:00
tasks fetch-sphinx: Exclude doctrees directory 2020-01-21 08:32:26 +01:00
README.rst Switch PDF file name to doc-PROJECT.pdf 2019-09-03 14:40:39 +02:00

README.rst

Collect output from a sphinx build as a tarball

By default, this copies the output from the sphinx build on the worker to the log root of the executor as a tarball, and then extracts the archive into the log root for viewing.

Role Variables