Merge "Build pdf docs"

doc/source/conf.py

@@ -227,6 +227,17 @@ texinfo_documents = [
    'Miscellaneous'),
 ]
 
+# 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}{3}',
+}
+
 # Documents to append as an appendix to all manuals.
 #texinfo_appendices = []
 

requirements.txt

@@ -1,5 +1,6 @@
 pbr>=2.0.0,!=2.1.0 # Apache-2.0
-sphinx>=1.6.2 # BSD
+sphinx!=1.6.6,!=1.6.7,>=1.6.5,<2.0.0;python_version=='2.7' # BSD
+sphinx!=1.6.6,!=1.6.7,>=1.6.5,!=2.1.0;python_version>='3.4' # BSD
 testtools>=1.4.0
 yasfb>=0.8.0
 openstackdocstheme>=1.19.0 # Apache-2.0

specs/newton/implemented/scoring-module.rst

@@ -124,7 +124,7 @@ That said, the following changes are going to be implemented:
 
 * In the watcher/common package:
 
-  * ScoringEngine class defining an abstract base class for all Scoring
+  ScoringEngine class defining an abstract base class for all Scoring
   Engine implementations. The abstract class will include the following
   abstract methods:
 

tox.ini

@@ -21,11 +21,26 @@ commands = {posargs}
 
 [testenv:docs]
 basepython = python3
+deps =
+  -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
+  -r{toxinidir}/requirements.txt
 setenv = PYTHONHASHSEED=0
 commands =
     find . -type f -name "*.pyc" -delete
     python setup.py build_sphinx
 
+[testenv:pdf-docs]
+basepython = python3
+envdir = {toxworkdir}/docs
+deps = {[testenv:docs]deps}
+whitelist_externals =
+  rm
+  make
+commands =
+  rm -rf doc/build/pdf
+  sphinx-build -W -b latex doc/source doc/build/pdf
+  make -C doc/build/pdf
+
 [testenv:pep8]
 basepython = python3
 deps =