Merge "Add PDF documentation build"
This commit is contained in:
commit
1b2cafb008
@ -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
|
||||
|
@ -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
|
||||
|
@ -33,8 +33,10 @@ Contributing
|
||||
|
||||
contributor/index
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
.. only:: html
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`search`
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`search`
|
||||
|
10
tox.ini
10
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 =
|
||||
|
Loading…
Reference in New Issue
Block a user