PDF Documentation Build tox target

This patch adds a `pdf-docs` tox target that will build
PDF versions of our docs. As per the Train community goal:

  https://governance.openstack.org/tc/goals/selected/train/pdf-doc-generation.html

Add sphinxcontrib-svg2pdfconverter to doc/requirements.txt
to convert our SVGs.

Change-Id: Ie55900a7a2b3f3696588100137847f1950cf72e2
Story: 2006105

doc/requirements.txt

@@ -10,7 +10,8 @@
 # automatically be proposed to all the repositories which use it.
 
 sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7'  # BSD
-sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4'  # BSD
+sphinx>=1.8.0,!=2.1.0,>=1.6.2;python_version>='3.4'  # BSD
-openstackdocstheme>=1.20.0 # Apache-2.0
+sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
+openstackdocstheme>=1.18.1 # Apache-2.0
 reno>=2.5.0 # Apache-2.0
 doc8>=0.6.0 # Apache-2.0

doc/source/conf.py

@@ -22,6 +22,7 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
+import openstackdocstheme
 import pbr.version
 
 # If extensions (or modules to document with autodoc) are in another directory,
@@ -40,6 +41,8 @@ import pbr.version
 extensions = [
     'openstackdocstheme',
     'sphinx.ext.autodoc',
+    'sphinx.ext.extlinks',
+    'sphinxcontrib.rsvgconverter',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -64,13 +67,20 @@ description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
 project = 'OpenStack-Ansible'
 role_name = 'os_keystone'
 target_name = 'openstack-ansible-' + role_name
-title = 'OpenStack-Ansible Documentation: ' + role_name + 'role'
+title = 'OpenStack-Ansible Documentation: ' + role_name + ' role'
 
 # The link to the browsable source code (for the left hand menu)
 oslosphinx_cgit_link = (
     "https://opendev.org/openstack/{}".format(target_name)
 )
 
+# References variable for substitutions
+current_series = openstackdocstheme.ext._get_series_name()
+deploy_guide_prefix = "https://docs.openstack.org/project-deploy-guide/openstack-ansible/{}/%s".format(current_series)
+
+# Format: Reference name: (string containing %s for substitution, linkname)
+extlinks = {'deploy_guide': (deploy_guide_prefix, '')}
+
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
@@ -249,8 +259,8 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, target_name + '.tex',
+    (master_doc, 'doc-' + target_name + '.tex',
-     title, author, 'manual'),
+     title.replace("_", "\_"), author, 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -309,3 +319,11 @@ texinfo_documents = [
 
 # If true, do not generate a @detailmenu in the "Top" node's menu.
 # texinfo_no_detailmenu = False
+# -- Options for PDF output --------------------------------------------------
+
+pdf_documents = [
+    (master_doc, target_name,
+     title, author)
+]
+
+locale_dirs = ['locale/']

tox.ini

@@ -35,12 +35,22 @@ setenv =
 [testenv:docs]
 basepython = python3
 deps = -r{toxinidir}/doc/requirements.txt
-commands=
+commands =
     bash -c "rm -rf doc/build"
     doc8 doc
     sphinx-build -b html doc/source doc/build/html
 
 
+[testenv:pdf-docs]
+basepython = python3
+deps = {[testenv:docs]deps}
+whitelist_externals =
+  make
+commands =
+  sphinx-build -W -b latex doc/source doc/build/pdf
+  make -C doc/build/pdf
+
+
 [doc8]
 # Settings for doc8:
 extensions = .rst