summaryrefslogtreecommitdiff
path: root/doc/source/plugin-commands.rst
Commit message (Collapse)AuthorAgeFilesLines
* reorganize existing documentation according to the new standard layoutDoug Hellmann2017-06-231-120/+0
| | | | | | | | | | | | | Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Add support for Karbor Pluginchenying2017-06-151-0/+6
| | | | | | | | | | | | | | | The patch[1] about OSC plugin has been submitted to karbor project. And the plan list commend has been implemented. With more dataprotection commands being supported, another patch adding more commands to the docs will be proposed later. [1] https://review.openstack.org/#/c/473508/ Depends-On: I4dfac08fd2b04f9ac254d3aa8fdadc3a1691de0a Change-Id: I2266525650f5c2e241373493dcd09474478c2ba6
* doc: Correct Sphinx warningsStephen Finucane2017-03-281-5/+4
| | | | | | | | | | | | | | | - 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
* Normalize the gnocchiclient docs entryliusheng2017-03-061-4/+4
| | | | | | | | 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
* Add plugin adoption for troveTrevor McCasland2017-01-171-0/+6
| | | | | | | | | | | | 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
* Update the doc for Zaqar v2wangxiyuan2016-10-141-1/+1
| | | | | | | 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
* Remove reference to CLI Ref in osc docKATO Tomoyuki2016-09-251-4/+0
| | | | | | | Since we decide to unify the osc doc into the osc repo, CLI Reference does not provide osc content. Change-Id: I0d530143105b5411a7a38e9e9d2297a1e8c69071
* [docs] fix incorrect rst markupsKATO Tomoyuki2016-08-241-22/+50
| | | | | | | | | 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
* Add python-neutronclient to OSC pluginsRichard Theis2016-07-051-0/+4
| | | | | | | | | | 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
* update plugin documentationSteve Martinelli2016-06-301-16/+41
| | | | | | | | - add watcher, gnocchi and aodh - organize sphinx docs based on alphabetical order of the library Change-Id: Ibdd500da0e488ce3256320d53b3354ee7c66468a
* update docs with status of pluginsSteve Martinelli2016-03-171-0/+20
| | | | | | | | | | | | | 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
* update heat object and command docMark Vanderwiel2016-02-251-0/+4
| | | | | | | | | | | | | | | | | 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
* autodocument commands from plugins using stevedore.sphinxextSteve Martinelli2015-12-011-0/+32
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