summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/source/commands.rst8
-rw-r--r--doc/source/plugins.rst6
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'