diff options
author | Zuul <zuul@review.opendev.org> | 2019-09-24 05:07:52 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2019-09-24 05:07:52 +0000 |
commit | b3a0da0f2004e66476992a6ce4a460849ff83d26 (patch) | |
tree | 8e9e003974047afe8c20405875b81390d0e7194b | |
parent | 2ff70525db923184337c8024ff79d939a749af5c (diff) | |
parent | f4e1b1585361fdccded59fe697d21129a3ebabaf (diff) | |
download | ceilometer-b3a0da0f2004e66476992a6ce4a460849ff83d26.tar.gz |
Merge "PDF documentation build"13.0.0.0rc1
-rw-r--r-- | doc/source/conf.py | 20 | ||||
-rw-r--r-- | doc/source/contributor/architecture.rst | 2 | ||||
-rw-r--r-- | doc/source/contributor/events.rst | 2 | ||||
-rw-r--r-- | doc/source/contributor/new_resource_types.rst | 2 | ||||
-rw-r--r-- | doc/source/contributor/overview.rst | 2 | ||||
-rw-r--r-- | doc/source/index.rst | 14 | ||||
-rw-r--r-- | tox.ini | 9 |
7 files changed, 33 insertions, 18 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index 985d1acd..51bcb90e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -187,22 +187,26 @@ htmlhelp_basename = 'Ceilometerdoc' # -- Options for LaTeX output ------------------------------------------------- +latex_domain_indices = False + latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - #'papersize': 'letterpaper', + 'makeindex': '', + 'printindex': '', + 'preamble': r'\setcounter{tocdepth}{3}', + 'maxlistdepth': '10', +} - # The font size ('10pt', '11pt' or '12pt'). - #'pointsize': '10pt', +# Disable usage of xindy https://bugzilla.redhat.com/show_bug.cgi?id=1643664 +latex_use_xindy = False - # Additional stuff for the LaTeX preamble. - #'preamble': '', -} +# Disable smartquotes, they don't work in latex +smartquotes_excludes = {'builders': ['latex']} # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ - ('index', 'Ceilometer.tex', u'Ceilometer Documentation', + ('index', 'doc-ceilometer.tex', u'Ceilometer Documentation', u'OpenStack Foundation', 'manual'), ] diff --git a/doc/source/contributor/architecture.rst b/doc/source/contributor/architecture.rst index 832c1d1d..8fc75109 100644 --- a/doc/source/contributor/architecture.rst +++ b/doc/source/contributor/architecture.rst @@ -183,6 +183,6 @@ Storing/Accessing the data Ceilometer is designed solely to generate and normalise cloud data. The data created by Ceilometer can be pushed to any number of target using publishers -mentioned in :ref:`pipeline-publishers` section. The recommended workflow is to +mentioned in `pipeline-publishers` section. The recommended workflow is to push data to Gnocchi_ for efficient time-series storage and resource lifecycle tracking. diff --git a/doc/source/contributor/events.rst b/doc/source/contributor/events.rst index 882a4e65..b73fbbea 100644 --- a/doc/source/contributor/events.rst +++ b/doc/source/contributor/events.rst @@ -49,7 +49,7 @@ Event Structure ~~~~~~~~~~~~~~~ To facilitate downstream processing (billing and/or aggregation), a -:doc:`minimum required data set and format <format>` has been defined for +`minimum required data set and format <format>` has been defined for services, however events generally contain the following information: event_type diff --git a/doc/source/contributor/new_resource_types.rst b/doc/source/contributor/new_resource_types.rst index e44e29da..673f6856 100644 --- a/doc/source/contributor/new_resource_types.rst +++ b/doc/source/contributor/new_resource_types.rst @@ -35,7 +35,7 @@ how to add/remove or update Gnocchi resource types to support new Ceilometer data. The modification or creation of Gnocchi resource type definitions are managed -:section:`resources_update_operations` of :file:`ceilometer/gnocchi_client.py`. +`resources_update_operations` of :file:`ceilometer/gnocchi_client.py`. The following operations are supported: diff --git a/doc/source/contributor/overview.rst b/doc/source/contributor/overview.rst index 3e455c47..794a73e6 100644 --- a/doc/source/contributor/overview.rst +++ b/doc/source/contributor/overview.rst @@ -16,7 +16,7 @@ As the project started to come to life, collecting an community started to realize that a secondary goal could be added to Ceilometer: become a standard way to meter, regardless of the purpose of the collection. This data can then be pushed to any set of targets -using provided publishers mentioned in :ref:`pipeline-publishers` section. +using provided publishers mentioned in `pipeline-publishers` section. .. _increasing number of meters: https://docs.openstack.org/ceilometer/latest/contributor/measurements.html diff --git a/doc/source/index.rst b/doc/source/index.rst index 5624aca6..187c26a1 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -17,7 +17,7 @@ Welcome to Ceilometer's documentation! ====================================== -The :term:`Ceilometer` project is a data collection service that provides the +The `Ceilometer` project is a data collection service that provides the ability to normalise and transform data across all current OpenStack core components with work underway to support future OpenStack components. @@ -51,9 +51,11 @@ Appendix .. update index -Indices and tables -================== +.. only:: html -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` + Indices and tables + ================== + + * :ref:`genindex` + * :ref:`modindex` + * :ref:`search` @@ -52,6 +52,15 @@ deps = -r{toxinidir}/doc/requirements.txt commands = sphinx-build -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 commands = {posargs} |