Merge "Generate PDF documentation"

This commit is contained in:
Zuul 2019-12-23 13:54:13 +00:00 committed by Gerrit Code Review
commit 5873b82fb6
3 changed files with 26 additions and 3 deletions

View File

@ -6,3 +6,4 @@ openstackdocstheme>=1.18.1 # Apache-2.0
sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD
reno>=2.5.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0
sphinxcontrib-httpdomain>=1.3.0 # BSD sphinxcontrib-httpdomain>=1.3.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

View File

@ -24,6 +24,7 @@ extensions = [
'sphinx.ext.autodoc', 'sphinx.ext.autodoc',
'openstackdocstheme', 'openstackdocstheme',
# 'sphinx.ext.intersphinx', # 'sphinx.ext.intersphinx',
'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
@ -73,11 +74,22 @@ htmlhelp_basename = '%sdoc' % project
# [howto/manual]). # [howto/manual]).
latex_documents = [ latex_documents = [
('index', ('index',
'%s.tex' % project, 'doc-heat-dashboard.tex',
u'%s Documentation' % project, u'Heat Dashboard Documentation',
u'OpenStack Developers', 'manual'), u'OpenStack Developers', 'manual', True),
] ]
latex_domain_indices = False
latex_elements = {
# Additional stuff for the LaTeX preamble.
# openany: Skip blank pages in generated PDFs
'extraclassoptions': 'openany,oneside',
'makeindex': '',
'printindex': '',
'preamble': r'\setcounter{tocdepth}{3}',
}
man_pages = [ man_pages = [
('index', u'Heat Dashboard Documentation', ('index', u'Heat Dashboard Documentation',
'Documentation for Heat Dashboard plugin to Openstack\ 'Documentation for Heat Dashboard plugin to Openstack\

10
tox.ini
View File

@ -51,6 +51,16 @@ deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/
-r{toxinidir}/doc/requirements.txt -r{toxinidir}/doc/requirements.txt
commands = python setup.py build_sphinx commands = python setup.py build_sphinx
[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] [testenv:releasenotes]
deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master} deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
-r{toxinidir}/doc/requirements.txt -r{toxinidir}/doc/requirements.txt