summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAkihiro Motoki <amotoki@gmail.com>2019-08-27 16:27:45 +0900
committerBernard Cafarelli <bcafarel@redhat.com>2019-09-05 12:27:30 +0000
commitd6c78a5d3995c36f4641d462009902c32b70795f (patch)
treeaa804496ba942f98655082f256ebbe83b3b57a94
parent62f4868e6e240ebbb4d6e29b8c1e1d23a24fcc15 (diff)
downloadpython-neutronclient-d6c78a5d3995c36f4641d462009902c32b70795f.tar.gz
PDF documentation build
Change-Id: I0abc5df1dfde23756bc2fd78631141ba685dc6fe Story: 2006099 Task: 35139
-rw-r--r--doc/source/conf.py19
-rw-r--r--tox.ini10
2 files changed, 29 insertions, 0 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index b1c6cee..294de71 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -49,6 +49,25 @@ html_theme = 'openstackdocs'
# Output file base name for HTML help builder.
htmlhelp_basename = 'neutronclientdoc'
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_documents = [
+ ('index', 'doc-python-neutronclient.tex',
+ u'python-neutronclient Documentation',
+ u'Neutron Contributors', 'manual'),
+]
+
+# 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}{5}',
+}
+
# -- Options for cliff.sphinxext plugin ---------------------------------------
autoprogram_cliff_application = 'openstack'
diff --git a/tox.ini b/tox.ini
index e248ee0..f9458ea 100644
--- a/tox.ini
+++ b/tox.ini
@@ -58,6 +58,16 @@ basepython = python3
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -W -b html doc/source doc/build/html
+[testenv:pdf-docs]
+basepython = python3
+envdir = {toxworkdir}/docs
+deps = {[testenv:docs]deps}
+whitelist_externals =
+ make
+commands =
+ sphinx-build -W -b latex doc/source doc/build/pdf
+ make -C doc/build/pdf
+
[testenv:releasenotes]
basepython = python3
deps = -r{toxinidir}/doc/requirements.txt