diff --git a/doc/requirements.txt b/doc/requirements.txt index f556feaeb..e2f8f6b67 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -6,3 +6,4 @@ openstackdocstheme>=1.19.0 # Apache-2.0 reno!=2.3.1,>=1.8.0 # Apache-2.0 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,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 682126a74..fba4509a5 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -40,8 +40,9 @@ extensions = [ 'sphinx.ext.autodoc', #'sphinx.ext.intersphinx', # Uncomment this to enable the OpenStack documentation style, adding - # oslosphinx to test-requirements.txt. + # oslosphinx to test-requirements.txt. #'oslosphinx', + 'sphinxcontrib.rsvgconverter', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -97,11 +98,14 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M' # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, + 'doc-%s.tex' % project, u'%s Documentation' % project, u'OpenStack Foundation', 'manual'), ] +# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664 +latex_use_xindy = False + # openstackdocstheme options # TODO(mgoddard): Change to openstack/kayobe. repository_name = 'openstack/kayobe' diff --git a/tox.ini b/tox.ini index 036e78884..b73f01575 100644 --- a/tox.ini +++ b/tox.ini @@ -118,6 +118,14 @@ deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -W -b html doc/source doc/build/html +[testenv:pdf-docs] +basepython = python3 +whitelist_externals = make +deps = {[testenv:docs]deps} +commands = + sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf + [testenv:debug] basepython = python3 commands = oslo_debug_helper {posargs}