diff --git a/doc/source/conf.py b/doc/source/conf.py index 878278e1b..0754af30d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -108,3 +108,27 @@ html_sidebars = { # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] + +# -- Options for LaTeX output ------------------------------------------------- + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', 'doc-murano.tex', u'Murano Documentation', + u'OpenStack Foundation', 'manual'), +] +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 + +# Disable smartquotes, they don't work in latex +smartquotes_excludes = {'builders': ['latex']} diff --git a/doc/source/configuration/config-options.rst b/doc/source/configuration/config-options.rst index 9064457cd..8b8a4a278 100644 --- a/doc/source/configuration/config-options.rst +++ b/doc/source/configuration/config-options.rst @@ -3,7 +3,10 @@ Configuration options for the Application Catalog service ========================================================= The following options can be set in the ``/etc/murano/murano.conf`` config file. -A :doc:`sample configuration file ` is also available. + +.. only:: html + + A :doc:`sample configuration file ` is also available. .. show-options:: :config-file: etc/oslo-config-generator/murano.conf diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst index a8cde7cad..9e19dc0bf 100644 --- a/doc/source/configuration/index.rst +++ b/doc/source/configuration/index.rst @@ -2,9 +2,11 @@ Configuration Guide =================== -.. toctree:: - :maxdepth: 1 +.. only:: html - config-options - sample_config - sample_policy + .. toctree:: + :maxdepth: 1 + + config-options + sample_config + sample_policy diff --git a/doc/source/configuration/sample_config.rst b/doc/source/configuration/sample_config.rst index 3e52bc395..94d36f8a0 100644 --- a/doc/source/configuration/sample_config.rst +++ b/doc/source/configuration/sample_config.rst @@ -7,6 +7,8 @@ auto-generated from murano when this documentation is built, so if you are having issues with an option, please compare your version of murano with the version of this documentation. -The sample configuration can also be downloaded in `file form <../_static/murano.conf.sample>`_. +.. only:: html + + The sample configuration can also be downloaded in `file form <../_static/murano.conf.sample>`_. .. literalinclude:: ../_static/murano.conf.sample diff --git a/tox.ini b/tox.ini index 917e35f9a..cf746e759 100644 --- a/tox.ini +++ b/tox.ini @@ -61,6 +61,15 @@ basepython = python3 deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html +[testenv:pdf-docs] +basepython = python3 +deps = {[testenv:docs]deps} +whitelist_externals = + make +commands = + sphinx-build -W -b latex doc/source doc/build/pdf + make -C doc/build/pdf + [testenv:pyflakes] basepython = python3 deps = flake8