Skip to content

Commit 67a4b81

Browse files
Jenkinsopenstack-gerrit
Jenkins
authored and
openstack-gerrit
committed
Merge "doc: Correct Sphinx warnings"
2 parents e059ade + 7017065 commit 67a4b81

14 files changed

Lines changed: 169 additions & 93 deletions

File tree

‎doc/source/backwards-incompatible.rst‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Releases Before 3.0
5757
2. <type> should not be optional for command `openstack service create`
5858

5959
Previously, the command was `openstack service create <name> --type <type>`,
60-
whereas now it is: `openstack service create <type> --name <name>`
60+
whereas now it is: `openstack service create <type> --name <name>`.
6161
This bug also affected python-keystoneclient, and keystone.
6262

6363
* In favor of: making <type> a positional argument.
@@ -181,12 +181,12 @@ Releases Before 3.0
181181
* Bug: https://bugs.launchpad.net/python-openstackclient/+bug/1546065
182182
* Commit: https://review.openstack.org/#/c/281088/
183183

184-
12. <version> <url> <md5hash> should be optional for command `openstack compute agent set`
184+
12. `<version> <url> <md5hash>` should be optional for command `openstack
185+
compute agent set`
185186

186-
Previously, the command was `openstack compute agent set <id> <version> <url> <md5hash>`,
187-
whereas now it is: `openstack compute agent set <id> --version <version>
188-
--url <url>
189-
--md5hash <md5hash>`.
187+
Previously, the command was `openstack compute agent set <id> <version> <url>
188+
<md5hash>`, whereas now it is: `openstack compute agent set <id> --version
189+
<version> --url <url> --md5hash <md5hash>`.
190190

191191
* In favor of: making <version> <url> <md5hash> optional.
192192
* As of: NA

‎doc/source/command-objects/consistency-group-snapshot.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Create new consistency group snapshot.
2727
Description of this consistency group snapshot
2828

2929
.. _consistency_group_snapshot_create-snapshot-name:
30-
.. option:: <snapshot-name>
30+
.. describe:: <snapshot-name>
3131

3232
Name of new consistency group snapshot (default to None)
3333

‎doc/source/command-objects/consistency-group.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Create new consistency group.
6262
(not available if creating consistency group from source)
6363

6464
.. _consistency_group_create-name:
65-
.. option:: <name>
65+
.. describe:: <name>
6666

6767
Name of new consistency group (default to None)
6868

‎doc/source/command-objects/endpoint.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Create new endpoint
1111

1212
*Identity version 2 only*
1313

14-
.. program:: endpoint create
14+
.. program:: endpoint create (v2)
1515
.. code:: bash
1616
1717
openstack endpoint create
@@ -44,7 +44,7 @@ Create new endpoint
4444

4545
*Identity version 3 only*
4646

47-
.. program:: endpoint create
47+
.. program:: endpoint create (v3)
4848
.. code:: bash
4949
5050
openstack endpoint create

‎doc/source/command-objects/volume.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,18 @@ Create new volume
3737

3838
Set the type of volume
3939

40-
Select :option:`\<volume-type\>` from the available types as shown
40+
Select ``<volume-type>`` from the available types as shown
4141
by ``volume type list``.
4242

4343
.. option:: --image <image>
4444

45-
Use :option:`\<image\>` as source of volume (name or ID)
45+
Use ``<image>`` as source of volume (name or ID)
4646

4747
This is commonly used to create a boot volume for a server.
4848

4949
.. option:: --snapshot <snapshot>
5050

51-
Use :option:`\<snapshot\>` as source of volume (name or ID)
51+
Use ``<snapshot>`` as source of volume (name or ID)
5252

5353
.. option:: --source <volume>
5454

@@ -72,7 +72,7 @@ Create new volume
7272

7373
.. option:: --availability-zone <availability-zone>
7474

75-
Create volume in :option:`\<availability-zone\>`
75+
Create volume in ``<availability-zone>``
7676

7777
.. option:: --consistency-group <consistency-group>
7878

@@ -163,7 +163,7 @@ List volumes
163163
164164
.. option:: --project <project>
165165
166-
Filter results by :option:`\<project\>` (name or ID) (admin only)
166+
Filter results by ``<project>`` (name or ID) (admin only)
167167
168168
*Volume version 2 only*
169169
@@ -177,7 +177,7 @@ List volumes
177177
178178
.. option:: --user <user>
179179
180-
Filter results by :option:`\<user\>` (name or ID) (admin only)
180+
Filter results by ``<user>`` (name or ID) (admin only)
181181
182182
*Volume version 2 only*
183183
@@ -337,8 +337,8 @@ Set volume properties
337337
(repeat option to set multiple image properties)
338338
339339
Image properties are copied along with the image when creating a volume
340-
using :option:`--image`. Note that these properties are immutable on the
341-
image itself, this option updates the copy attached to this volume.
340+
using ``--image``. Note that these properties are immutable on the image
341+
itself, this option updates the copy attached to this volume.
342342
343343
*Volume version 2 only*
344344

‎doc/source/command-options.rst‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,10 @@ new command without understanding why or why not that instance is correct.
1616

1717
The :doc:`Human Interface Guide <humaninterfaceguide>`
1818
describes the guildelines for option names and usage. In short:
19-
* All option names shall be GNU-style long names (two leading dashes).
20-
* Some global options may have short names, generally limited to those defined
21-
in support libraries such as ``cliff``.
19+
20+
* All option names shall be GNU-style long names (two leading dashes).
21+
* Some global options may have short names, generally limited to those defined
22+
in support libraries such as ``cliff``.
2223

2324
General Command Options
2425
=======================

‎doc/source/index.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Developer Documentation
5757
command-errors
5858
command-logs
5959
specs/commands
60+
api/modules
6061

6162
Project Goals
6263
-------------
@@ -92,5 +93,4 @@ Indices and Tables
9293
==================
9394

9495
* :ref:`genindex`
95-
* :ref:`modindex`
9696
* :ref:`search`

0 commit comments

Comments
 (0)