summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorWalter A. Boring IV <waboring@hemna.com>2019-08-20 13:20:38 -0700
committerWalter A. Boring IV (hemna) <waboring@hemna.com>2019-08-27 01:49:02 +0000
commit4c031b92948553a00c1fc32e0c355a88efaffb3c (patch)
tree20d28280304d6e9d0541d9ad8e757f0167b8c145 /doc
parentc4b50a10b3970aaf2d2e675e2fe8fd9b9bd4496b (diff)
downloadpython-cinderclient-4c031b92948553a00c1fc32e0c355a88efaffb3c.tar.gz
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
Diffstat (limited to 'doc')
-rw-r--r--doc/source/conf.py47
1 files changed, 47 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a2b3d40..839fe56 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -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']