diff --git a/docs/build_generated_docs.py b/docs/build_generated_docs.py index 8888ea49..021adf59 100644 --- a/docs/build_generated_docs.py +++ b/docs/build_generated_docs.py @@ -252,7 +252,8 @@ def build_runner_examples(): results['%s-output-only' % name] = format_cmd_output(None, output, name) results['metrics-providers'] = '' for m in MetricsProvider.providers_by_name().keys(): - results['metrics-providers'] += '* :py:class:`~.%s`\n' % m + results['metrics-providers'] += '* :py:class:`~awslimitchecker.' \ + 'metrics.%s.%s`\n' % (m.lower(), m) results['limit-override-json'] = dedent(""" { "AutoScaling": { diff --git a/docs/source/awslimitchecker.alerts.dummy.rst b/docs/source/awslimitchecker.alerts.dummy.rst new file mode 100644 index 00000000..b1c594e2 --- /dev/null +++ b/docs/source/awslimitchecker.alerts.dummy.rst @@ -0,0 +1,7 @@ +awslimitchecker.alerts.dummy module +=================================== + +.. automodule:: awslimitchecker.alerts.dummy + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/awslimitchecker.alerts.rst b/docs/source/awslimitchecker.alerts.rst index 532643f7..c8846f8e 100644 --- a/docs/source/awslimitchecker.alerts.rst +++ b/docs/source/awslimitchecker.alerts.rst @@ -12,4 +12,5 @@ Submodules .. toctree:: awslimitchecker.alerts.base + awslimitchecker.alerts.dummy diff --git a/docs/source/cli_usage.rst b/docs/source/cli_usage.rst index 9e70f6a0..132d63a9 100644 --- a/docs/source/cli_usage.rst +++ b/docs/source/cli_usage.rst @@ -506,8 +506,8 @@ can be seen with the ``--list-metrics-providers`` option: The configuration options required by each metrics provider are specified in the providers' documentation: -* :py:class:`~.Dummy` -* :py:class:`~.Datadog` +* :py:class:`~awslimitchecker.metrics.dummy.Dummy` +* :py:class:`~awslimitchecker.metrics.datadog.Datadog` For example, to use the :py:class:`~awslimitchecker.metrics.datadog.Datadog` diff --git a/docs/source/development.rst b/docs/source/development.rst index 630926bd..1bd22a04 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -225,6 +225,7 @@ implement a new one, but there are a few important things to keep in mind: extras but installed in the Docker image. * The constructor should do as much validation (i.e. authentication test) as possible. +* Metrics provider classes should be in a module with the same name. .. _development.tests: