diff --git a/README.rst b/README.rst index 51e4c1c99..53ae74a69 100644 --- a/README.rst +++ b/README.rst @@ -10,9 +10,11 @@ Team and repository tags Python bindings to the OpenStack Manila API =========================================== -.. image:: https://img.shields.io/pypi/v/python-manilaclient.svg - :target: https://pypi.org/project/python-manilaclient/ - :alt: Latest Version +.. only: html + + .. image:: https://img.shields.io/pypi/v/python-manilaclient.svg + :target: https://pypi.org/project/python-manilaclient/ + :alt: Latest Version This is a client for the OpenStack Manila API. There's a Python API (the ``manilaclient`` module), and a command-line script (``manila``). Each diff --git a/doc/source/conf.py b/doc/source/conf.py index 742cd4f70..f642def35 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -82,3 +82,38 @@ bug_project = 'python-manilaclient' bug_tag = 'docs' html_last_updated_fmt = '%Y-%m-%d %H:%M' +# -- Options for LaTeX output ------------------------------------------------- + +# Docs job does not install xindy +latex_use_xindy = False + +# The paper size ('letter' or 'a4'). +# latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +# latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass +# [howto/manual]). +latex_documents = [ + ('index', 'Manila-client.tex', u'Manila Python Client Documentation', + u'Manila contributors', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +# latex_preamble = '' + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_use_modindex = True diff --git a/doc/source/index.rst b/doc/source/index.rst index 6b3ba349a..54a5cd22c 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -33,8 +33,10 @@ Contributing contributor/index -Indices and tables -================== +.. only:: html -* :ref:`genindex` -* :ref:`search` + Indices and tables + ================== + + * :ref:`genindex` + * :ref:`search` diff --git a/tox.ini b/tox.ini index 0c02b7893..0f4e97b84 100644 --- a/tox.ini +++ b/tox.ini @@ -49,6 +49,16 @@ commands = rm -rf doc/build sphinx-build -b html doc/source doc/build/html +[testenv:pdf-docs] +usedevelop = True +basepthon = 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:releasenotes] basepython = python3 deps =