diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-13 15:55:33 -0400 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2017-06-23 11:54:32 +0200 |
| commit | 9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch) | |
| tree | 9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/specs/command-objects | |
| parent | 19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff) | |
| download | python-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz | |
reorganize existing documentation according to the new standard layout
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>
Diffstat (limited to 'doc/source/specs/command-objects')
| -rw-r--r-- | doc/source/specs/command-objects/example.rst | 86 |
1 files changed, 0 insertions, 86 deletions
diff --git a/doc/source/specs/command-objects/example.rst b/doc/source/specs/command-objects/example.rst deleted file mode 100644 index fa559433..00000000 --- a/doc/source/specs/command-objects/example.rst +++ /dev/null @@ -1,86 +0,0 @@ -======= -example -======= - -This is a specification for the ``example`` command object. It is not intended -to be a complete template for new commands since other actions, options -and/or arguments may be used. You can include general specification information -before the commands below. This information could include links to related material -or descriptions of similar commands. - -[example API name] [example API version] - -example create --------------- - -Create new example - -.. program:: example create -.. code:: bash - - openstack example create - <name> - -.. describe:: <name> - - New example name - -example delete --------------- - -Delete example(s) - -.. program:: example delete -.. code:: bash - - openstack example delete - <example> [<example> ...] - -.. describe:: <example> - - Example(s) to delete (name or ID) - -example list ------------- - -List examples - -.. program:: example list -.. code:: bash - - openstack example list - -example set ------------ - -Set example properties - -.. program:: example set -.. code:: bash - - openstack example set - [--name <new-name>] - <example> - -.. option:: --name <new-name> - - New example name - -.. describe:: <example> - - Example to modify (name or ID) - -example show ------------- - -Display example details - -.. program:: example show -.. code:: bash - - openstack example show - <example> - -.. describe:: <example> - - Example to display (name or ID) |