Skip to content

Commit 46b14af

Browse files
committed
update plugin documentation
- add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
1 parent fc804a5 commit 46b14af

3 files changed

Lines changed: 45 additions & 18 deletions

File tree

doc/source/plugin-commands.rst

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,51 +6,76 @@ Note: To see the complete syntax for the plugin commands, see the `CLI_Ref`_
66

77
.. list-plugins:: openstack.cli.extension
88

9-
.. list-plugins:: openstack.key_manager.v1
9+
# aodh
10+
.. list-plugins:: openstack.alarming.v2
1011
:detailed:
1112

12-
.. list-plugins:: openstack.baremetal.v1
13+
# barbican
14+
.. list-plugins:: openstack.key_manager.v1
1315
:detailed:
1416

17+
# congress
1518
.. list-plugins:: openstack.congressclient.v1
1619
:detailed:
1720

18-
.. list-plugins:: openstack.workflow_engine.v2
19-
:detailed:
21+
# cue
22+
.. # cueclient is not in global-requirements
23+
.. # list-plugins:: openstack.mb.v1
24+
.. # :detailed:
2025
21-
.. list-plugins:: openstack.data_processing.v1
26+
# designate
27+
.. list-plugins:: openstack.dns.v1
2228
:detailed:
2329

24-
.. list-plugins:: openstack.dns.v1
30+
# gnocchi
31+
.. # gnocchiclient is not in global-requirements
32+
.. # list-plugins:: openstack.metric.v1
33+
.. # :detailed:
34+
35+
# heat
36+
.. list-plugins:: openstack.orchestration.v1
2537
:detailed:
2638

27-
.. list-plugins:: openstack.management.v1
39+
# ironic
40+
.. list-plugins:: openstack.baremetal.v1
2841
:detailed:
2942

30-
.. list-plugins:: openstack.messaging.v1
43+
# ironic-inspector
44+
.. list-plugins:: openstack.baremetal_introspection.v1
3145
:detailed:
3246

33-
.. list-plugins:: openstack.orchestration.v1
47+
# mistral
48+
.. list-plugins:: openstack.workflow_engine.v2
3449
:detailed:
3550

36-
.. list-plugins:: openstack.search.v1
51+
# murano
52+
.. list-plugins:: openstack.application_catalog.v1
3753
:detailed:
3854

39-
.. list-plugins:: openstack.baremetal_introspection.v1
55+
# sahara
56+
.. list-plugins:: openstack.data_processing.v1
4057
:detailed:
4158

42-
.. list-plugins:: openstack.application_catalog.v1
59+
# searchlight
60+
.. list-plugins:: openstack.search.v1
4361
:detailed:
4462

63+
# senlin
4564
.. list-plugins:: openstack.clustering.v1
4665
:detailed:
4766

67+
# tripleo
4868
.. # tripleoclient is not in global-requirements
49-
.. #.. list-plugins:: openstack.tripleoclient.v1
69+
.. # list-plugins:: openstack.tripleoclient.v1
5070
.. # :detailed:
5171
52-
.. # cueclient is not in global-requirements
53-
.. #.. list-plugins:: openstack.mb.v1
54-
.. # :detailed:
72+
# watcher
73+
.. # watcherclient is not in global-requirements
74+
.. # list-plugins:: openstack.infra_optim.v1
75+
.. # :detailed:
76+
77+
# zaqar
78+
.. list-plugins:: openstack.messaging.v1
79+
:detailed:
5580

5681
.. _CLI_Ref: http://docs.openstack.org/cli-reference/openstack.html

doc/source/plugins.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ OpenStackClient.
2121

2222
The following is a list of projects that are an OpenStackClient plugin.
2323

24+
- aodhclient
25+
- gnocchiclient\*\*
2426
- python-barbicanclient
2527
- python-congressclient
2628
- python-cueclient\*\*
@@ -34,14 +36,13 @@ The following is a list of projects that are an OpenStackClient plugin.
3436
- python-searchlightclient
3537
- python-senlinclient
3638
- python-tripleoclient\*\*
39+
- python-watcherclient\*\*
3740
- python-zaqarclient
3841

3942
\*\* Note that some clients are not listed in global-requirements
4043

4144
The following is a list of projects that are not an OpenStackClient plugin.
4245

43-
- aodhclient
44-
- gnocchiclient
4546
- python-troveclient
4647
- python-magnumclient
4748
- python-ceilometerclient

test-requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ osprofiler>=1.3.0 # Apache-2.0
2020
bandit>=1.0.1 # Apache-2.0
2121

2222
# Install these to generate sphinx autodocs
23+
aodhclient>=0.5.0 # Apache-2.0
2324
python-barbicanclient>=4.0.0 # Apache-2.0
2425
python-congressclient<2000,>=1.3.0 # Apache-2.0
2526
python-designateclient>=1.5.0 # Apache-2.0

0 commit comments

Comments
 (0)