Add support for building pdf documentation

This patch updates tox.ini to build the pdf version of
cinderclient documentation.

run tox -epdf-docs

Change-Id: If1f43e593db6ff6740b8a88b517c4505e39a3edd
This commit is contained in:
Walter A. Boring IV 2019-08-20 13:20:38 -07:00 committed by Walter A. Boring IV (hemna)
parent c4b50a10b3
commit 4c031b9294
2 changed files with 59 additions and 0 deletions
doc/source
tox.ini

@ -93,3 +93,50 @@ man_pages = [
repository_name = 'openstack/python-cinderclient'
bug_project = 'cinderclient'
bug_tag = ''
# -- Options for LaTeX output -------------------------------------------------
# The paper size ('letter' or 'a4').
# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
latex_documents = [
('index', 'python-cinderclient.tex', u'Cinder Client Documentation',
u'Cinder Contributors', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# Additional stuff for the LaTeX preamble.
# latex_preamble = ''
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# latex_use_modindex = True
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
latex_use_xindy = False
latex_domain_indices = False
latex_elements = {
'makeindex': '',
'printindex': '',
'preamble': r'\setcounter{tocdepth}{3}',
}
latex_additional_files = ['cinderclient.sty']

12
tox.ini

@ -60,6 +60,18 @@ deps =
-r{toxinidir}/doc/requirements.txt
commands = sphinx-build -W -b html doc/source doc/build/html
[testenv:pdf-docs]
basepython = python3
deps =
{[testenv:docs]deps}
commands =
{[testenv:docs]commands}
sphinx-build -W -b latex doc/source doc/build/pdf
make -C doc/build/pdf
whitelist_externals =
make
cp
[testenv:releasenotes]
basepython = python3
deps =