Build pdf doc

The is one of community goals that each project should produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is
recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: Ib8a238f5ad4329527147be72331b87f57877f68e
This commit is contained in:
Mark Goddard 2019-09-17 12:07:33 +01:00
parent a3d3649c5e
commit 798b7dfc53
3 changed files with 15 additions and 2 deletions

View File

@ -6,3 +6,4 @@ openstackdocstheme>=1.19.0 # Apache-2.0
reno!=2.3.1,>=1.8.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,>=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 sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

View File

@ -40,8 +40,9 @@ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
#'sphinx.ext.intersphinx', #'sphinx.ext.intersphinx',
# Uncomment this to enable the OpenStack documentation style, adding # Uncomment this to enable the OpenStack documentation style, adding
# oslosphinx to test-requirements.txt. # oslosphinx to test-requirements.txt.
#'oslosphinx', #'oslosphinx',
'sphinxcontrib.rsvgconverter',
] ]
# autodoc generation is a bit aggressive and a nuisance when doing heavy # 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]). # [howto/manual]).
latex_documents = [ latex_documents = [
('index', ('index',
'%s.tex' % project, 'doc-%s.tex' % project,
u'%s Documentation' % project, u'%s Documentation' % project,
u'OpenStack Foundation', 'manual'), u'OpenStack Foundation', 'manual'),
] ]
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
latex_use_xindy = False
# openstackdocstheme options # openstackdocstheme options
# TODO(mgoddard): Change to openstack/kayobe. # TODO(mgoddard): Change to openstack/kayobe.
repository_name = 'openstack/kayobe' repository_name = 'openstack/kayobe'

View File

@ -118,6 +118,14 @@ deps =
-r{toxinidir}/doc/requirements.txt -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -W -b html doc/source doc/build/html 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] [testenv:debug]
basepython = python3 basepython = python3
commands = oslo_debug_helper {posargs} commands = oslo_debug_helper {posargs}