Merge "Generate PDF documentation"

doc/source/conf.py

@@ -27,6 +27,11 @@ extensions = [
     'oslo_config.sphinxext',
 ]
 
+# sphinxcontrib.apidoc options
+config_generator_config_file = (
+    '../../etc/masakarimonitors/masakarimonitors-config-generator.conf')
+sample_config_basename = '_static/masakarimonitors'
+
 # autodoc generation is a bit aggressive and a nuisance when doing heavy
 # text edit cycles.
 # execute "export SPHINX_DEBUG=1" in your terminal to disable
@@ -65,20 +70,20 @@ openstackdocs_bug_project = 'masakari-monitors'
 # Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % project
 
+# -- Options for LaTeX output -------------------------------------------------
+
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass
 # [howto/manual]).
 latex_documents = [
     ('index',
-     '%s.tex' % project,
+     'doc-%s.tex' % project,
      '%s Documentation' % project,
      'OpenStack Foundation', 'manual'),
 ]
 
-# Example configuration for intersphinx: refer to the Python standard library.
+# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
-#intersphinx_mapping = {'http://docs.python.org/': None}
+latex_use_xindy = False
 
-# sphinxcontrib.apidoc options
+# Disable smartquotes, they don't work in latex
-config_generator_config_file = (
+smartquotes_excludes = {'builders': ['latex']}
-    '../../etc/masakarimonitors/masakarimonitors-config-generator.conf')
-sample_config_basename = '_static/masakarimonitors'

doc/source/index.rst

@@ -17,20 +17,21 @@ Contents:
    reference/conf
    reference/conf-file
 
-For Contributors
+.. only:: html
-================
 
-* If you are a new contributor to Masakari Monitors please refer: :doc:`contributor/contributing`
+   For Contributors
+   ================
 
-  .. toctree::
+   * If you are a new contributor to Masakari Monitors please refer: :doc:`contributor/contributing`
-     :hidden:
 
-     contributor/contributing
+      .. toctree::
+         :hidden:
 
-Indices and tables
+         contributor/contributing
-==================
 
-* :ref:`genindex`
+   Indices and tables
-* :ref:`modindex`
+   ==================
-* :ref:`search`
 
+   * :ref:`genindex`
+   * :ref:`modindex`
+   * :ref:`search`

tox.ini

@@ -43,6 +43,14 @@ deps =
    -r{toxinidir}/doc/requirements.txt
 commands = sphinx-build -W -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 = {[testenv:docs]deps}
 commands =