openstack/python-openstackclient
Code Issues Proposed changes
1686dc54f0
python-openstackclient/doc/source/plugin-commands.rst

115 lines
1.7 KiB
ReStructuredText
Raw Normal View History

[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
===============
Plugin Commands
===============
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
.. list-plugins:: openstack.cli.extension
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
aodh
----
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. list-plugins:: openstack.alarming.v2
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
barbican
--------
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. list-plugins:: openstack.key_manager.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
congress
--------
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
.. list-plugins:: openstack.congressclient.v1
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
.. cue
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. # cueclient is not in global-requirements
.. # list-plugins:: openstack.mb.v1
.. # :detailed:
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
designate
---------
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. list-plugins:: openstack.dns.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
Normalize the gnocchiclient docs entry For now, gnocchiclient has been added in the global-requirements, we should add gnocchiclient in test-requirements.txt and normalize the docs entry. Change-Id: Ide5d8262e7f7c5b1ca304fa72893ccfbf16d8ec1
2017-03-06 19:20:45 +08:00
gnocchi
-------
.. list-plugins:: openstack.metric.v1
:detailed:
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
heat
----
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. list-plugins:: openstack.orchestration.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
ironic
------
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. list-plugins:: openstack.baremetal.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
ironic-inspector
----------------
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. list-plugins:: openstack.baremetal_introspection.v1
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
mistral
-------
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. list-plugins:: openstack.workflow_engine.v2
autodocument commands from plugins using stevedore.sphinxext conflicting command names are a painpoint, so is manually updating a list. let's autodocument the commands that are being use by existing osc supporters. Change-Id: If37d81dfd57cc79803668b64be1ccd776e319572
2015-10-16 02:08:05 -04:00
:detailed:
update heat object and command doc Many OpenStack client heat command patches are in progress, seems like good time to also update some of the highlevel doc. Added new objects for orchestration and software openstack orchestration resource type list/show openstack software config create/delete/show/list Added new action for restore openstack stack snapshot create/delete/list/show/restore Added link to CLI reference for complete plugin syntax and details Removed deprecated tasker client Change-Id: I2c94a5981954edcba95f364a0f909c799f1c403b Blueprint: heat-support-python-openstackclient
2015-12-10 15:14:01 -06:00
doc: Correct Sphinx warnings - Fix option-describe typos - Correct option and envvar markup, for commands that are using the reference form instead of the definition form or are marking up option arguments as options - Avoid duplicate commands - Fix some invalid docstrings - Fix some invalid indentation - Disable the murano plugin, which has invalid docs - Correct issues with- and track the network-topology spec - Include API modules in docs Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
2017-03-20 16:19:27 +00:00
.. murano
.. # the murano docs cause warnings and a broken docs build
.. # .. list-plugins:: openstack.application_catalog.v1
.. # :detailed:
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
neutron
-------
Add python-neutronclient to OSC plugins Neutron is transitioning its CLI to OSC. Some CLIs will reside within python-openstackclient while others will be OSC plugins within python-neutronclient. Depends-On: I9a20bc7a3d8aa7b631fb0fd534fc5705c23326ce Change-Id: I2d8d369739d1df1597201368dd2158e07c8d2baf Related-Bug: #1521291
2016-04-22 12:30:19 -05:00
.. list-plugins:: openstack.neutronclient.v2
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
sahara
------
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. list-plugins:: openstack.data_processing.v1
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
searchlight
-----------
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. list-plugins:: openstack.search.v1
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
senlin
------
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
.. list-plugins:: openstack.clustering.v1
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
.. tripleo
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
.. # tripleoclient is not in global-requirements
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. # list-plugins:: openstack.tripleoclient.v1
update docs with status of plugins several other projects have joined the bandwagon, let's add them to the list, these include: python-ironic-inspector-client python-muranoclient python-senlinclient python-tripleoclient python-searchlightclient Change-Id: I9165daf64bf817b9e12ee8fc27ce6e11ebe01e5e
2016-03-17 18:32:06 -04:00
.. # :detailed:
Add plugin adoption for trove With I308a6c6f3f5ce7dbb814ec0fd8ecb1734a2f137f merged in the python-troveclient project, trove can now say it has adopted the plugin. What commands that actually get implemented for this cycle, is to be determined. Another patch adding more commands to the docs will be proposed later when they get merged. Change-Id: If2c2545dd5d1510cc6eece698e34ad0f8c1b970f
2017-01-17 09:50:40 -06:00
trove
------
.. list-plugins:: openstack.database.v1
:detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
.. watcher
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
.. # watcherclient is not in global-requirements
.. # list-plugins:: openstack.infra_optim.v1
.. # :detailed:
[docs] fix incorrect rst markups The incorrect md-style markups break Sphinx builds, which do not properly generate web page. http://docs.openstack.org/developer/python-openstackclient/plugin-commands.html Change-Id: I36ae2cf922836cff42653283c0a683359bd91344
2016-08-24 16:35:06 +09:00
zaqar
-----
Update the doc for Zaqar v2 Zaqar v1 and v1.1 is deprecated now, and the V2 is the default API version. Update the plugin doc for it. Change-Id: I26db823852ba543607b250a09aae63bb439a8959
2016-10-14 15:37:52 +08:00
.. list-plugins:: openstack.messaging.v2
update plugin documentation - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
2016-06-30 12:55:02 -04:00
:detailed:
Copy Permalink