Browse Source

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.

Story: 2006070
Task: 35475

Change-Id: Iea3e848b5b914dd837a8fcef154d967ba9fa7008
changes/06/750906/6
Lukas Piwowarski 10 months ago
parent
commit
ebca247375
3 changed files with 17 additions and 6 deletions
  1. +9
    -3
      doc/source/conf.py
  2. +1
    -3
      doc/source/index.rst
  3. +7
    -0
      tox.ini

+ 9
- 3
doc/source/conf.py View File

@ -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.
@ -55,6 +55,7 @@ openstackdocs_repo_name = 'openstack/tempest-stress'
openstackdocs_auto_name = False
openstackdocs_bug_project = 'tempest'
openstackdocs_bug_tag = 'doc'
openstackdocs_pdf_link = True
# -- Options for HTML output --------------------------------------------------
@ -74,10 +75,15 @@ htmlhelp_basename = '%sdoc' % project
# [howto/manual]).
latex_documents = [
('index',
'%s.tex' % project,
u'%s Documentation' % project,
'doc-tempest-stress.tex',
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',
}

+ 1
- 3
doc/source/index.rst View File

@ -4,9 +4,7 @@
contain the root `toctree` directive.
Welcome to tempest_stress's documentation!
========================================================
Contents:
==========================================
.. toctree::
:maxdepth: 2


+ 7
- 0
tox.ini View File

@ -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…
Cancel
Save