Create tox environment to build pdf documentation

This patch enables building .pdf documentation using new 'pdf-docs'
tox environment. The newly created tox environment creates latex
source codes using sphinx-build and then builds the pdf
documentation using make.

Change-Id: I915bf4d5a0ef92329af1d3b137328595dcfe0a69

doc/requirements.txt

@@ -2,3 +2,4 @@ openstackdocstheme>=2.2.1 # Apache-2.0
 reno>=3.1.0 # Apache-2.0
 sphinx>=2.0.0,!=2.1.0 # BSD
 sphinx-argparse>=0.2.2 # MIT
+sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

doc/source/conf.py

@@ -21,6 +21,7 @@ extensions = [
     'openstackdocstheme',
     #'sphinx.ext.intersphinx',
     'sphinx.ext.autodoc',
+    'sphinxcontrib.rsvgconverter',
     'sphinxarg.ext'
 ]
 
@@ -28,6 +29,7 @@ html_theme = 'openstackdocs'
 
 # openstackdocstheme options
 openstackdocs_repo_name = 'openstack/openstack-tempest-skiplist'
+openstackdocs_pdf_link = True
 openstackdocs_use_storyboard = True
 
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
@@ -70,10 +72,15 @@ htmlhelp_basename = '%sdoc' % project
 # [howto/manual]).
 latex_documents = [
     ('index',
-     '%s.tex' % project,
+     'doc-%s.tex' % project,
      u'%s Documentation' % project,
      u'Red Hat, Inc.', 'manual'),
 ]
 
+latex_use_xindy = False
+latex_elements = {
+    'extraclassoptions': 'openany,oneside',
+}
+
 # Example configuration for intersphinx: refer to the Python standard library.
 #intersphinx_mapping = {'http://docs.python.org/': None}

doc/source/listyaml/listyaml.rst

@@ -9,12 +9,13 @@ You can use :command:`tempest-skip` list command to list tests in the yaml
 file with one positional and two optional parameters which is in the expected
 format::
 
-1. ``--file`` is the positional parameter - lists all the tests in the file::
+    1. ``--file`` is the positional parameter - lists all the tests in the file::
 
         $ tempest-skip list yaml --file tempest_skip.yml
 
-2. ``--release``, ``--deployment`` and ``--job`` are the optional parameters
-   - list all the tests within specific release, deployment or specific job::
+    2. ``--release``, ``--deployment`` and ``--job`` are the optional
+       parameters - list all the tests within a specific release, deployment
+       or a specific job::
 
        $ tempest-skip list --file tempest_skip.yml --release train
        $ tempest-skip list --file tempest_skip.yml --job job1
@@ -27,4 +28,4 @@ always parse the --job option. In this scenario, if a job2 is parsed, and there
 is no test with job2, it would return zero tests to be skipped, which is not
 the intent. The test with no job defined, means, skip everywhere, if you
 define the job in the test yaml file, it means, skip all the tests that doesn't
-have a job defined, plus this test
+have a job defined, plus this test.

tox.ini

@@ -44,6 +44,14 @@ commands =
 deps = -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -b html doc/source doc/build/html
 
+[testenv:pdf-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]
 deps = -r{toxinidir}/doc/requirements.txt
 commands =