PDF documentation build

Change-Id: Idc50caec499d899e18231bae9e40a0c6af2ca506
This commit is contained in:
matthew-fuller
2019-09-24 15:59:12 -07:00
committed by Matthew Fuller
parent a0c894a222
commit a65e055024
4 changed files with 87 additions and 58 deletions

View File

@@ -78,10 +78,23 @@ htmlhelp_basename = 'magnumdoc'
# [howto/manual]).
latex_documents = [
('index',
'magnum.tex',
'doc-magnum.tex',
u'magnum Documentation',
u'OpenStack Foundation', 'manual'),
]
# If false, no module index is generated.
latex_domain_indices = False
latex_elements = {
'makeindex': '',
'printindex': '',
'preamble': r'\setcounter{tocdepth}{3}',
'maxlistdepth': 10,
}
# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664
latex_use_xindy = False
# Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {'http://docs.python.org/': None}

View File

@@ -7,7 +7,14 @@ auto-generated from Magnum when this documentation is built, so
if you are having issues with an option, please compare your version of
Magnum with the version of this documentation.
.. only:: html
The sample configuration can also be viewed in :download:`file form
</_static/magnum.conf.sample>`.
.. literalinclude:: /_static/magnum.conf.sample
.. only:: latex
See the online version of this documentation for the full example config
file.

View File

@@ -45,11 +45,11 @@ Cluster Drivers
Kubernetes Terminology
~~~~~~~~~~~~~~~~~~~~~~
.. glossary::
Kubernetes uses a range of terminology that we refer to in this guide. We
define these common terms for your reference:
.. glossary::
Pod
When using the Kubernetes container orchestration engine, a pod is the
smallest deployable unit that can be created and managed. A pod is a

View File

@@ -138,6 +138,15 @@ basepython = python3
deps = -r{toxinidir}/doc/requirements.txt
commands = sphinx-build -W -b html doc/source doc/build/html
[testenv:pdf-docs]
basepython = python3
deps = {[testenv:docs]deps}
whitelist_externals =
make
commands =
sphinx-build -b latex doc/source doc/build/pdf
make -C doc/build/pdf
[testenv:genconfig]
basepython = python3
commands =