diff options
| author | Jenkins <jenkins@review.openstack.org> | 2014-10-03 22:36:19 +0000 |
|---|---|---|
| committer | Gerrit Code Review <review@openstack.org> | 2014-10-03 22:36:19 +0000 |
| commit | 86d258f6585cc4006276007b02ce1bc1f4234c2c (patch) | |
| tree | 191501f501e47b681fe56b0c69386813c0edfe1e | |
| parent | 1934b1b24347fbe528c02fd8eafcd4c569e96763 (diff) | |
| parent | 89bb5b0b8528ac793b9fc531a24ba709f73a8716 (diff) | |
| download | python-openstackclient-86d258f6585cc4006276007b02ce1bc1f4234c2c.tar.gz | |
Merge "Add some code-blocks to the docs"
| -rw-r--r-- | doc/source/commands.rst | 8 | ||||
| -rw-r--r-- | doc/source/plugins.rst | 6 |
2 files changed, 8 insertions, 6 deletions
diff --git a/doc/source/commands.rst b/doc/source/commands.rst index 45e73a05..8857f3d5 100644 --- a/doc/source/commands.rst +++ b/doc/source/commands.rst @@ -47,11 +47,13 @@ objects. In badly formed English it is expressed as "(Take) object1 <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 diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst index 3b35ec08..0635f29e 100644 --- a/doc/source/plugins.rst +++ b/doc/source/plugins.rst @@ -14,7 +14,7 @@ Plugins are discovered by enumerating the entry points found under :py:mod:`openstack.cli.extension` and initializing the specified client module. -:: +.. code-block:: ini [entry_points] 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 defined for the API version: -:: +.. code-block:: ini openstack.oscplugin.v1 = 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>` so the version should not contain the leading 'v' character. -:: +.. code-block:: python DEFAULT_OSCPLUGIN_API_VERSION = '1' |