11 Commits

Author SHA1 Message Date
Stephen Finucane
70170656fd 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-28 16:41:54 +01:00
liusheng
d07704dd25 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:27:04 +08:00
Trevor McCasland
ab1f637f55 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 19:26:48 +00:00
wangxiyuan
928fecd134 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:38:17 +08:00
KATO Tomoyuki
50ad04df97 Remove reference to CLI Ref in osc doc
Since we decide to unify the osc doc into the osc repo,
CLI Reference does not provide osc content.

Change-Id: I0d530143105b5411a7a38e9e9d2297a1e8c69071
2016-09-25 14:20:20 +09:00
KATO Tomoyuki
50a5c2a163 [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:38:21 +09:00
Richard Theis
578065b2c8 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-07-05 09:37:05 -05:00
Steve Martinelli
46b14afc3f 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:57:42 -04:00
Steve Martinelli
92aa981fa8 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 19:10:44 -04:00
Mark Vanderwiel
69d5bc4e55 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
2016-02-25 00:48:15 +00:00
Steve Martinelli
727792da17 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-12-01 01:23:56 -05:00