Browse Source

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.

Story: 2006083
Task: 34856
changes/14/680114/9
manchandavishal 2 years ago
committed by Vishal Manchanda
parent
commit
e064697989
  1. 1
      doc/requirements.txt
  2. 18
      doc/source/conf.py
  3. 10
      tox.ini

1
doc/requirements.txt

@ -7,3 +7,4 @@ 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;python_version>='3.4' # BSD
reno>=2.5.0 # Apache-2.0
sphinxcontrib-httpdomain>=1.3.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD

18
doc/source/conf.py

@ -24,6 +24,7 @@ extensions = [
'sphinx.ext.autodoc',
'openstackdocstheme',
# 'sphinx.ext.intersphinx',
'sphinxcontrib.rsvgconverter',
]
# autodoc generation is a bit aggressive and a nuisance when doing heavy
@ -73,11 +74,22 @@ htmlhelp_basename = '%sdoc' % project
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
u'%s Documentation' % project,
u'OpenStack Developers', 'manual'),
'doc-heat-dashboard.tex',
u'Heat Dashboard Documentation',
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 = [
('index', u'Heat Dashboard Documentation',
'Documentation for Heat Dashboard plugin to Openstack\

10
tox.ini

@ -61,6 +61,16 @@ deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/
-r{toxinidir}/doc/requirements.txt
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]
basepython = python3
deps = -c{env:UPPER_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}

Loading…
Cancel
Save