Generate PDF documentation

This commit adds a new tox target to build PDF documentation.
It's a part of community goal, see storyboard for more
information.

Change-Id: I58b1fb537c3758bba5a57d3cf7ce4cf10625bd89
Story: 2006076
Task: 34813
This commit is contained in:
whoami-rajat 2019-09-11 12:30:10 +05:30 committed by Rajat Dhasmana
parent 25e36d4a71
commit 4eedd98a4e
2 changed files with 26 additions and 3 deletions

View File

@ -102,14 +102,27 @@ htmlhelp_basename = '%sdoc' % project
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# 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}',
}
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
# NOTE: Specify toctree_only=True for a better document structure of
# the generated PDF file.
latex_documents = [
('index',
'%s.tex' % project,
u'%s Documentation' % project,
u'OpenStack Foundation', 'manual'),
'doc-%s.tex' % project,
u'Congress Documentation',
u'OpenStack Foundation', 'manual', True),
]
# Example configuration for intersphinx: refer to the Python standard library.

10
tox.ini
View File

@ -83,6 +83,16 @@ deps = -r{toxinidir}/doc/requirements.txt
commands = rm -rf doc/build doc/source/api
sphinx-build -W -b html doc/source doc/build/html
[testenv:pdf-docs]
basepython = python3
envdir = {toxworkdir}/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]
basepython = python3
deps = -r{toxinidir}/doc/requirements.txt