3 Commits

Author SHA1 Message Date
Ghanshyam Mann
aaaafbb5b8 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
2020-07-03 11:24:43 -05:00
Matthew Treinish
1719dfeb69 Use the oslo.config sphinx module to generate sample
This commit switches to using the oslo.config sphinx extension to
generate a sample config instead of doing it manually in the docs'
conf.py module.

Change-Id: I7032cb4f56c728911ffa5c6911eb504f53bc80af
2015-08-25 14:21:43 +00:00
Mathew Odden
b389faa22f Include sample configuration in dev docs
Since including the sample configuration in tree is
becoming difficult to maintain, lets try moving it to
the developer docs. We still have the ability to view it
easily for users, and it can be auto-generated on doc build,
so it should also always be up to date.

Change-Id: I7ec2d76448feef5ecb9af7c238bbd12619fa31d8
2015-08-04 10:59:38 -04:00