diff --git a/.gitignore b/.gitignore index 87b598219..fb4dcc0a7 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,4 @@ subunit.log releasenotes/build /doc/source/contributor/api/ doc/source/_static/aodh.policy.yaml.sample +doc/source/_static/aodh.conf.sample diff --git a/doc/source/conf.py b/doc/source/conf.py index f4315999e..aad731726 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -199,10 +199,25 @@ htmlhelp_basename = 'Aodhdoc' # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ - ('index', 'Aodh.tex', u'Aodh Documentation', + ('index', 'doc-aodh.tex', u'Aodh Documentation', u'OpenStack Foundation', 'manual'), ] +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']} + +latex_domain_indices = False + # The name of an image file (relative to this directory) to place at the top of # the title page. #latex_logo = None diff --git a/tox.ini b/tox.ini index f51bc35a6..92f144f0b 100644 --- a/tox.ini +++ b/tox.ini @@ -48,6 +48,15 @@ deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -W -b html doc/source doc/build/html setenv = PYTHONHASHSEED=0 +[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:venv] basepython = python3 deps = -r{toxinidir}/doc/requirements.txt