diff --git a/doc/source/developer/collector.rst b/doc/source/developer/collector.rst index 260f2432..e849bab0 100644 --- a/doc/source/developer/collector.rst +++ b/doc/source/developer/collector.rst @@ -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 diff --git a/tox.ini b/tox.ini index 3045aba2..34a31fbf 100644 --- a/tox.ini +++ b/tox.ini @@ -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}