Create tox environment to build pdf documentation
This patch enables building .pdf documentation using new 'pdf-docs' tox environment. The newly created tox environment creates latex source codes using sphinx-build and then builds the pdf documentation using make. Change-Id: Iea3e848b5b914dd837a8fcef154d967ba9fa7008 Task: 35475
This commit is contained in:
parent
82f7e4a1ff
commit
90c8bafb9a
|
@ -37,7 +37,7 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'tempest_stress'
|
||||
project = u'tempest-stress'
|
||||
copyright = u'2016, OpenStack Foundation'
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
|
@ -75,9 +75,14 @@ htmlhelp_basename = '%sdoc' % project
|
|||
latex_documents = [
|
||||
('index',
|
||||
'%s.tex' % project,
|
||||
u'%s Documentation' % project,
|
||||
u'Tempest-stress Documentation',
|
||||
u'OpenStack Foundation', 'manual'),
|
||||
]
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
#intersphinx_mapping = {'http://docs.python.org/': None}
|
||||
|
||||
latex_use_xindy = False
|
||||
latex_elements = {
|
||||
'extraclassoptions': 'openany,oneside',
|
||||
}
|
||||
|
|
|
@ -4,9 +4,7 @@
|
|||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to tempest_stress's documentation!
|
||||
========================================================
|
||||
|
||||
Contents:
|
||||
==========================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
|
7
tox.ini
7
tox.ini
|
@ -42,6 +42,13 @@ commands =
|
|||
[testenv:docs]
|
||||
commands = sphinx-build -W -b html doc/source doc/build/html
|
||||
|
||||
[testenv:pdf-docs]
|
||||
whitelist_externals =
|
||||
make
|
||||
commands =
|
||||
sphinx-build -W -b latex doc/source doc/build/pdf
|
||||
make -C doc/build/pdf
|
||||
|
||||
[testenv:debug]
|
||||
commands = oslo_debug_helper {posargs}
|
||||
|
||||
|
|
Loading…
Reference in New Issue