From 70170656fd4d3c8020391354b13dca63e9e024d1 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <sfinucan@redhat.com>
Date: Mon, 20 Mar 2017 16:19:27 +0000
Subject: 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
---
 .../command-objects/consistency-group-snapshot.rst       |  2 +-
 doc/source/command-objects/consistency-group.rst         |  2 +-
 doc/source/command-objects/endpoint.rst                  |  4 ++--
 doc/source/command-objects/volume.rst                    | 16 ++++++++--------
 4 files changed, 12 insertions(+), 12 deletions(-)

(limited to 'doc/source/command-objects')

diff --git a/doc/source/command-objects/consistency-group-snapshot.rst b/doc/source/command-objects/consistency-group-snapshot.rst
index 3d455038..29d50656 100644
--- a/doc/source/command-objects/consistency-group-snapshot.rst
+++ b/doc/source/command-objects/consistency-group-snapshot.rst
@@ -27,7 +27,7 @@ Create new consistency group snapshot.
     Description of this consistency group snapshot
 
 .. _consistency_group_snapshot_create-snapshot-name:
-.. option:: <snapshot-name>
+.. describe:: <snapshot-name>
 
     Name of new consistency group snapshot (default to None)
 
diff --git a/doc/source/command-objects/consistency-group.rst b/doc/source/command-objects/consistency-group.rst
index 232cf8e4..57082c6d 100644
--- a/doc/source/command-objects/consistency-group.rst
+++ b/doc/source/command-objects/consistency-group.rst
@@ -62,7 +62,7 @@ Create new consistency group.
     (not available if creating consistency group from source)
 
 .. _consistency_group_create-name:
-.. option:: <name>
+.. describe:: <name>
 
     Name of new consistency group (default to None)
 
diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst
index b98055a1..02a75bea 100644
--- a/doc/source/command-objects/endpoint.rst
+++ b/doc/source/command-objects/endpoint.rst
@@ -11,7 +11,7 @@ Create new endpoint
 
 *Identity version 2 only*
 
-.. program:: endpoint create
+.. program:: endpoint create (v2)
 .. code:: bash
 
     openstack endpoint create
@@ -44,7 +44,7 @@ Create new endpoint
 
 *Identity version 3 only*
 
-.. program:: endpoint create
+.. program:: endpoint create (v3)
 .. code:: bash
 
     openstack endpoint create
diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst
index 67598e63..85a920eb 100644
--- a/doc/source/command-objects/volume.rst
+++ b/doc/source/command-objects/volume.rst
@@ -37,18 +37,18 @@ Create new volume
 
     Set the type of volume
 
-    Select :option:`\<volume-type\>` from the available types as shown
+    Select ``<volume-type>`` from the available types as shown
     by ``volume type list``.
 
 .. option:: --image <image>
 
-    Use :option:`\<image\>` as source of volume (name or ID)
+    Use ``<image>`` as source of volume (name or ID)
 
     This is commonly used to create a boot volume for a server.
 
 .. option:: --snapshot <snapshot>
 
-    Use :option:`\<snapshot\>` as source of volume (name or ID)
+    Use ``<snapshot>`` as source of volume (name or ID)
 
 .. option:: --source <volume>
 
@@ -72,7 +72,7 @@ Create new volume
 
 .. option:: --availability-zone <availability-zone>
 
-    Create volume in :option:`\<availability-zone\>`
+    Create volume in ``<availability-zone>``
 
 .. option:: --consistency-group <consistency-group>
 
@@ -163,7 +163,7 @@ List volumes
 
 .. option:: --project <project>
 
-    Filter results by :option:`\<project\>` (name or ID) (admin only)
+    Filter results by ``<project>`` (name or ID) (admin only)
 
     *Volume version 2 only*
 
@@ -177,7 +177,7 @@ List volumes
 
 .. option:: --user <user>
 
-    Filter results by :option:`\<user\>` (name or ID) (admin only)
+    Filter results by ``<user>`` (name or ID) (admin only)
 
     *Volume version 2 only*
 
@@ -337,8 +337,8 @@ Set volume properties
     (repeat option to set multiple image properties)
 
     Image properties are copied along with the image when creating a volume
-    using :option:`--image`.  Note that these properties are immutable on the
-    image itself, this option updates the copy attached to this volume.
+    using ``--image``.  Note that these properties are immutable on the image
+    itself, this option updates the copy attached to this volume.
 
     *Volume version 2 only*
 
-- 
cgit v1.2.1