Merge "PDF documentation build"

doc/source/conf.py

@@ -218,10 +218,10 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M'
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author,
 # documentclass [howto/manual]).
-#latex_documents = [
-#    ('index', 'Neutron.tex', u'Neutron Documentation',
-#     u'Neutron development team', 'manual'),
-#]
+latex_documents = [
+    ('index', 'doc-neutron-vpnaas.tex', u'Neutron VPN-as-a-Service Documentation',
+     u'Neutron development team', 'manual'),
+]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
@@ -240,6 +240,18 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M'
 # 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 = {
+    'extraclassoptions': 'openany,oneside',
+    'makeindex': '',
+    'printindex': '',
+    'preamble': r'\setcounter{tocdepth}{3}',
+}
+
 # -- Options for openstackdocstheme -------------------------------------------
 repository_name = 'openstack/neutron-vpnaas'
 bug_project = 'neutron'

doc/source/index.rst

@@ -21,7 +21,8 @@ Welcome to Neutron VPNaaS documentation!
 Neutron VPNaaS provides Virtual Private Network as a Service (VPNaaS)
 capabilities to Neutron. Maintained as a separate repo, this works in
 conjunction with the Neutron repo to provide VPN services for OpenStack.
-The `VPNaaS API`_ is implementation as an extension to Neutron's networking API:
+The `VPNaaS API`_ is implementation as an extension to the OpenStack
+networking API.
 
 .. _`VPNaaS API`: https://docs.openstack.org/api-ref/network/v2/index.html#vpnaas-2-0-vpn-vpnservices-ikepolicies-ipsecpolicies-endpoint-groups-ipsec-site-connections
 
@@ -48,7 +49,9 @@ For Contributors
 
    contributor/index
 
-Search
-------
+.. only:: html
 
-* :ref:`search`
+   Search
+   ------
+
+   * :ref:`search`

tox.ini

@@ -119,6 +119,15 @@ commands = {posargs}
 basepython = python3
 commands = sphinx-build -W -a -b html doc/source doc/build/html
 
+[testenv:pdf-docs]
+basepython = python3
+envdir = {toxworkdir}/docs
+whitelist_externals =
+  make
+commands =
+  sphinx-build -W -b latex doc/source doc/build/pdf
+  make -C doc/build/pdf
+
 [flake8]
 # E125 continuation line does not distinguish itself from next logical line
 # E126 continuation line over-indented for hanging indent