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: 35460 Change-Id: I1f0ca39747e8ef95d2b93cd00214911d4a7408a9
This commit is contained in:
parent
cf43bcb7b4
commit
2381d9112d
|
@ -34,6 +34,7 @@ extensions = ['sphinx.ext.autodoc',
|
||||||
openstackdocs_repo_name = 'openstack/devstack-tools'
|
openstackdocs_repo_name = 'openstack/devstack-tools'
|
||||||
openstackdocs_bug_project = 'devstack-tools'
|
openstackdocs_bug_project = 'devstack-tools'
|
||||||
openstackdocs_bug_tag = 'doc'
|
openstackdocs_bug_tag = 'doc'
|
||||||
|
openstackdocs_pdf_link = True
|
||||||
|
|
||||||
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
# autodoc generation is a bit aggressive and a nuisance when doing heavy
|
||||||
# text edit cycles.
|
# text edit cycles.
|
||||||
|
@ -141,9 +142,12 @@ suppress_warnings = ['image.nonlocal_uri']
|
||||||
# (source start file, target name, title, author, documentclass
|
# (source start file, target name, title, author, documentclass
|
||||||
# [howto/manual]).
|
# [howto/manual]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index', 'doc-tempest.tex', u'Tempest Testing Project',
|
('index', 'doc-devstack-tools.tex', u'Devstack-tools Documentation',
|
||||||
u'OpenStack Foundation', 'manual'),
|
u'OpenStack Foundation', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
|
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
|
||||||
latex_use_xindy = False
|
latex_use_xindy = False
|
||||||
|
latex_elements = {
|
||||||
|
'extraclassoptions': 'openany,oneside',
|
||||||
|
}
|
||||||
|
|
|
@ -6,8 +6,6 @@
|
||||||
Welcome to devstack-tools's documentation!
|
Welcome to devstack-tools's documentation!
|
||||||
========================================================
|
========================================================
|
||||||
|
|
||||||
Contents:
|
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
|
|
8
tox.ini
8
tox.ini
|
@ -34,6 +34,14 @@ commands =
|
||||||
sphinx-build -W -b html doc/source doc/build/html
|
sphinx-build -W -b html doc/source doc/build/html
|
||||||
whitelist_externals = rm
|
whitelist_externals = rm
|
||||||
|
|
||||||
|
[testenv:pdf-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 = {[testenv:docs]deps}
|
deps = {[testenv:docs]deps}
|
||||||
commands =
|
commands =
|
||||||
|
|
Loading…
Reference in New Issue