summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGhanshyam Mann <gmann@ghanshyammann.com>2020-07-03 11:24:43 -0500
committerGhanshyam Mann <gmann@ghanshyammann.com>2020-07-03 11:24:43 -0500
commitaaaafbb5b8ab04b6f1c6e8a7f1c1df2044984470 (patch)
treec1d5bae806ee92bbfed7cecdff625cf0df258de4 /doc
parentc5e33135a9378fad87e420ee0ba920175eaf9ae2 (diff)
downloadtempest-aaaafbb5b8ab04b6f1c6e8a7f1c1df2044984470.tar.gz
Fix pdf-doc build by skiping the sample file
Tempest pdf doc build includes the sample config file which is large in size and end up with error 'Dimension too large' - https://zuul.opendev.org/t/openstack/build/84d73ec987d04c05acc54b231d33067e/log/sphinx-build-pdf.log#1874 Its happening while adding new config option in https://review.opendev.org/#/c/686073/ which means we are at the edge of pdf build limit. We should not include the sample config file as part of pdf build. Change-Id: I59383505989705d35d86b19b5c1aaafebd2bd307 Closes-Bug: #1886212
Diffstat (limited to 'doc')
-rw-r--r--doc/source/sampleconf.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/source/sampleconf.rst b/doc/source/sampleconf.rst
index c2901400d..45164a314 100644
--- a/doc/source/sampleconf.rst
+++ b/doc/source/sampleconf.rst
@@ -10,4 +10,6 @@ Tempest with the version of this documentation.
The sample configuration can also be viewed in `file form <_static/tempest.conf.sample>`_.
-.. literalinclude:: _static/tempest.conf.sample
+.. only:: html
+
+ .. literalinclude:: _static/tempest.conf.sample