From 46b14afc3f34935683bb582362b614adbe1349d9 Mon Sep 17 00:00:00 2001 From: Steve Martinelli Date: Thu, 30 Jun 2016 12:55:02 -0400 Subject: [PATCH] update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a --- doc/source/plugin-commands.rst | 61 ++++++++++++++++++++++++---------- doc/source/plugins.rst | 5 +-- test-requirements.txt | 1 + 3 files changed, 47 insertions(+), 20 deletions(-) diff --git a/doc/source/plugin-commands.rst b/doc/source/plugin-commands.rst index b23e7a338e..66e1d72c25 100644 --- a/doc/source/plugin-commands.rst +++ b/doc/source/plugin-commands.rst @@ -6,51 +6,76 @@ Note: To see the complete syntax for the plugin commands, see the `CLI_Ref`_ .. list-plugins:: openstack.cli.extension +# aodh +.. list-plugins:: openstack.alarming.v2 + :detailed: + +# barbican .. list-plugins:: openstack.key_manager.v1 :detailed: -.. list-plugins:: openstack.baremetal.v1 - :detailed: - +# congress .. list-plugins:: openstack.congressclient.v1 :detailed: -.. list-plugins:: openstack.workflow_engine.v2 - :detailed: - -.. list-plugins:: openstack.data_processing.v1 - :detailed: +# cue +.. # cueclient is not in global-requirements +.. # list-plugins:: openstack.mb.v1 +.. # :detailed: +# designate .. list-plugins:: openstack.dns.v1 :detailed: -.. list-plugins:: openstack.management.v1 - :detailed: - -.. list-plugins:: openstack.messaging.v1 - :detailed: +# gnocchi +.. # gnocchiclient is not in global-requirements +.. # list-plugins:: openstack.metric.v1 +.. # :detailed: +# heat .. list-plugins:: openstack.orchestration.v1 :detailed: -.. list-plugins:: openstack.search.v1 +# ironic +.. list-plugins:: openstack.baremetal.v1 :detailed: +# ironic-inspector .. list-plugins:: openstack.baremetal_introspection.v1 :detailed: +# mistral +.. list-plugins:: openstack.workflow_engine.v2 + :detailed: + +# murano .. list-plugins:: openstack.application_catalog.v1 :detailed: +# sahara +.. list-plugins:: openstack.data_processing.v1 + :detailed: + +# searchlight +.. list-plugins:: openstack.search.v1 + :detailed: + +# senlin .. list-plugins:: openstack.clustering.v1 :detailed: +# tripleo .. # tripleoclient is not in global-requirements -.. #.. list-plugins:: openstack.tripleoclient.v1 +.. # list-plugins:: openstack.tripleoclient.v1 .. # :detailed: -.. # cueclient is not in global-requirements -.. #.. list-plugins:: openstack.mb.v1 -.. # :detailed: +# watcher +.. # watcherclient is not in global-requirements +.. # list-plugins:: openstack.infra_optim.v1 +.. # :detailed: + +# zaqar +.. list-plugins:: openstack.messaging.v1 + :detailed: .. _CLI_Ref: http://docs.openstack.org/cli-reference/openstack.html \ No newline at end of file diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst index 00aa5137ae..412edd104b 100644 --- a/doc/source/plugins.rst +++ b/doc/source/plugins.rst @@ -21,6 +21,8 @@ OpenStackClient. The following is a list of projects that are an OpenStackClient plugin. +- aodhclient +- gnocchiclient\*\* - python-barbicanclient - python-congressclient - python-cueclient\*\* @@ -34,14 +36,13 @@ The following is a list of projects that are an OpenStackClient plugin. - python-searchlightclient - python-senlinclient - python-tripleoclient\*\* +- python-watcherclient\*\* - python-zaqarclient \*\* Note that some clients are not listed in global-requirements The following is a list of projects that are not an OpenStackClient plugin. -- aodhclient -- gnocchiclient - python-troveclient - python-magnumclient - python-ceilometerclient diff --git a/test-requirements.txt b/test-requirements.txt index 9e82a5fc2d..b1413f66f0 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -20,6 +20,7 @@ osprofiler>=1.3.0 # Apache-2.0 bandit>=1.0.1 # Apache-2.0 # Install these to generate sphinx autodocs +aodhclient>=0.5.0 # Apache-2.0 python-barbicanclient>=4.0.0 # Apache-2.0 python-congressclient<2000,>=1.3.0 # Apache-2.0 python-designateclient>=1.5.0 # Apache-2.0