summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZuul <zuul@review.opendev.org>2019-08-30 09:18:13 +0000
committerGerrit Code Review <review@openstack.org>2019-08-30 09:18:13 +0000
commite23d9780bf222986d3764f1cdfd03100a29929ca (patch)
tree88e1ad484a2acb8d61284771ecf92c2a8f6a3bda
parent4e3588f3903f53b3892d1a9f64d6bdb1e0edb82c (diff)
parent4c031b92948553a00c1fc32e0c355a88efaffb3c (diff)
downloadpython-cinderclient-e23d9780bf222986d3764f1cdfd03100a29929ca.tar.gz
Merge "Add support for building pdf documentation"
-rw-r--r--doc/source/conf.py47
-rw-r--r--tox.ini12
2 files changed, 59 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']
diff --git a/tox.ini b/tox.ini
index d3f1e1d..bfc523f 100644
--- a/tox.ini
+++ b/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 =