diff options
| author | Matthew Oliver <matt@oliver.net.au> | 2019-09-04 14:39:40 +1000 |
|---|---|---|
| committer | Tim Burke <tim.burke@gmail.com> | 2019-09-04 11:29:37 -0700 |
| commit | 14095c109fe35bdbbaf7703328edf8bfe759700b (patch) | |
| tree | 03290a5704efc9e0f38a9dc47a5fb97d39874da6 | |
| parent | a0f0aedb41ba790266cca678fc3bd91696888835 (diff) | |
| download | python-swiftclient-14095c109fe35bdbbaf7703328edf8bfe759700b.tar.gz | |
PDF Documentation Build tox target
This patch adds a `pdf-docs` tox target that will build
PDF versions of our docs. As per the Train community goal:
https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html
Story: 2006122
Task: 35514
Change-Id: I7e0ee410ac603774e4b03f859ac3aa20e5afc9b8
| -rw-r--r-- | doc/source/conf.py | 4 | ||||
| -rw-r--r-- | tox.ini | 9 |
2 files changed, 12 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 85dd81e..a8ad3ad 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -181,7 +181,7 @@ htmlhelp_basename = 'SwiftClientwebdoc' # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]) latex_documents = [ - ('index', 'SwiftClient.tex', u'SwiftClient Documentation', + ('index', 'doc-python-swiftclient.tex', u'SwiftClient Documentation', u'OpenStack, LLC.', 'manual'), ] @@ -201,3 +201,5 @@ latex_documents = [ # If false, no module index is generated. # latex_use_modindex = True + +latex_use_xindy = False @@ -109,3 +109,12 @@ deps = -c{toxinidir}/lower-constraints.txt -r{toxinidir}/test-requirements.txt .[keystone] + +[testenv:pdf-docs] +basepython = python3 +deps = {[testenv:docs]deps} +whitelist_externals = + make +commands = + sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf |