openstack/python-openstackclient
Code Issues Proposed changes

Merge "Add some code-blocks to the docs"

Browse Source
This commit is contained in:
Jenkins
2014-10-03 22:36:19 +00:00
committed by Gerrit Code Review
parent 1934b1b243 89bb5b0b85
commit 86d258f658
2 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/commands.rst
View File

@@ -47,11 +47,13 @@ objects. In badly formed English it is expressed as "(Take) object1
<object-1> <action> <object-2> <object-1> <action> <object-2>
Examples:: Examples:
group add user <group> <user> .. code-block:: bash
volume type list # 'volume type' is a two-word single object $ group add user <group> <user>
$ volume type list # 'volume type' is a two-word single object
Command Arguments and Options Command Arguments and Options

6
doc/source/plugins.rst
View File

@@ -14,7 +14,7 @@ Plugins are discovered by enumerating the entry points
found under :py:mod:`openstack.cli.extension` and initializing the specified found under :py:mod:`openstack.cli.extension` and initializing the specified
client module. client module.
:: .. code-block:: ini
[entry_points] [entry_points]
openstack.cli.extension = openstack.cli.extension =
@@ -39,7 +39,7 @@ The client module must implement the following interface functions:
OSC enumerates the plugin commands from the entry points in the usual manner OSC enumerates the plugin commands from the entry points in the usual manner
defined for the API version: defined for the API version:
:: .. code-block:: ini
openstack.oscplugin.v1 = openstack.oscplugin.v1 =
plugin_list = oscplugin.v1.plugin:ListPlugin plugin_list = oscplugin.v1.plugin:ListPlugin
@@ -48,7 +48,7 @@ defined for the API version:
Note that OSC defines the group name as :py:mod:`openstack.<api-name>.v<version>` Note that OSC defines the group name as :py:mod:`openstack.<api-name>.v<version>`
so the version should not contain the leading 'v' character. so the version should not contain the leading 'v' character.
:: .. code-block:: python
DEFAULT_OSCPLUGIN_API_VERSION = '1' DEFAULT_OSCPLUGIN_API_VERSION = '1'