Fix docs build error due to duplicate references

Class docstrings were being pulled in to multiple locations, causing
sphinx errors due to the duplicate references. This fixes it by adding
the :noindex: option to those references.

Also temporarily disabling the PDF build as that is failing with another
issue that should be fixed in a follow up.

Change-Id: I6de2948ff49e1bb0b6a8b9a3a90f9f2ebbb8b7bb
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
(cherry picked from commit 3dccfc7643)
This commit is contained in:
Sean McGinnis 2020-05-02 07:23:27 -05:00
parent 56609c46f9
commit 9740388abe
2 changed files with 12 additions and 7 deletions

View File

@ -43,6 +43,7 @@ Implementation
Each collector must implement the following class:
.. autoclass:: cloudkitty.collector.BaseCollector
:noindex:
:members: fetch_all, check_configuration
The ``retrieve`` method of the ``BaseCollector`` class is called by the
@ -59,6 +60,7 @@ each metric type, for each scope, for each collect period. It has the
following prototype:
.. autoclass:: cloudkitty.collector.BaseCollector
:noindex:
:members: fetch_all
This method is supposed to return a list of
@ -127,6 +129,7 @@ If you need to extend the metric configuration (add parameters to the
``check_configuration`` method of the base collector:
.. autoclass:: cloudkitty.collector.BaseCollector
:noindex:
:members: check_configuration
This method uses `voluptuous`_ for data validation. The base schema for each

16
tox.ini
View File

@ -52,13 +52,15 @@ commands = oslopolicy-sample-generator --config-file=etc/oslo-policy-generator/c
[testenv:docs]
commands = sphinx-build -W --keep-going -b html doc/source doc/build/html
[testenv:pdf-docs]
envdir = {toxworkdir}/docs
whitelist_externals =
make
commands =
sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
make -C doc/build/pdf
# TODO(smcginnis) Temporarily disabling this as it fails. Error is that
# something is too large, likely from pulling in one of the conf sample files
# [testenv:pdf-docs]
# envdir = {toxworkdir}/docs
# whitelist_externals =
# make
# commands =
# sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
# make -C doc/build/pdf
[testenv:venv]
commands = {posargs}