Skip to content

Commit 27b73ac

Browse files
author
Steve Martinelli
committed
Fix doc building errors
Addresses some of the issues that appeared when running tox -edocs Change-Id: I31133744ee0ddefa72c6590cb381de317e65633e
1 parent b9e50a7 commit 27b73ac

6 files changed

Lines changed: 50 additions & 28 deletions

File tree

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ aggregate add host
1212

1313
Add host to aggregate
1414

15-
.. program aggregate add host
15+
.. program:: aggregate add host
1616
.. code:: bash
1717
1818
os aggregate add host
@@ -33,7 +33,7 @@ aggregate create
3333

3434
Create a new aggregate
3535

36-
.. program aggregate create
36+
.. program:: aggregate create
3737
.. code:: bash
3838
3939
os aggregate create
@@ -58,7 +58,7 @@ aggregate delete
5858

5959
Delete an existing aggregate
6060

61-
.. program aggregate delete
61+
.. program:: aggregate delete
6262
.. code:: bash
6363
6464
os aggregate delete
@@ -73,7 +73,7 @@ aggregate list
7373

7474
List all aggregates
7575

76-
.. program aggregate list
76+
.. program:: aggregate list
7777
.. code:: bash
7878
7979
os aggregate list
@@ -88,7 +88,7 @@ aggregate remove host
8888

8989
Remove host from aggregate
9090

91-
.. program aggregate remove host
91+
.. program:: aggregate remove host
9292
.. code:: bash
9393
9494
os aggregate remove host
@@ -100,7 +100,7 @@ Remove host from aggregate
100100

101101
Aggregate (name or ID)
102102

103-
.. option:: <host>
103+
.. describe:: <host>
104104

105105
Host to remove from :ref:`\<aggregate\> <aggregate_remove_host-aggregate>`
106106

@@ -109,7 +109,7 @@ aggregate set
109109

110110
Set aggregate properties
111111

112-
.. program aggregate set
112+
.. program:: aggregate set
113113
.. code:: bash
114114
115115
os aggregate set
@@ -141,7 +141,7 @@ aggregate show
141141

142142
Display aggregate details
143143

144-
.. program aggregate show
144+
.. program:: aggregate show
145145
.. code:: bash
146146
147147
os aggregate show

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Create new container
1515
os container create
1616
<container-name> [<container-name> ...]
1717
18-
.. option:: <container-name>
18+
.. describe:: <container-name>
1919

2020
New container name(s)
2121

@@ -30,7 +30,7 @@ Delete container
3030
os container delete
3131
<container> [<container> ...]
3232
33-
.. option:: <container>
33+
.. describe:: <container>
3434

3535
Container(s) to delete
3636

@@ -70,7 +70,7 @@ List containers
7070

7171
List additional fields in output
7272

73-
.. options:: --all
73+
.. option:: --all
7474

7575
List all containers (default is 10000)
7676

@@ -85,7 +85,7 @@ Save container contents locally
8585
os container save
8686
<container>
8787
88-
.. option:: <container>
88+
.. describe:: <container>
8989

9090
Container to save
9191

@@ -100,6 +100,6 @@ Display container details
100100
os container show
101101
[<container>]
102102
103-
.. option:: <container>
103+
.. describe:: <container>
104104

105105
Container to display

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ Upload object to container
1616
<container>
1717
<filename> [<filename> ...]
1818
19-
.. option:: <container>
19+
.. describe:: <container>
2020

2121
Container for new object
2222

23-
.. option:: <filename>
23+
.. describe:: <filename>
2424

2525
Local filename(s) to upload
2626

@@ -36,11 +36,11 @@ Delete object from container
3636
<container>
3737
<object> [<object> ...]
3838
39-
.. option:: <container>
39+
.. describe:: <container>
4040

4141
Delete object(s) from <container>
4242

43-
.. option:: <object>
43+
.. describe:: <object>
4444

4545
Object(s) to delete
4646

@@ -86,11 +86,11 @@ List objects
8686

8787
List additional fields in output
8888

89-
.. options:: --all
89+
.. option:: --all
9090

9191
List all objects in <container> (default is 10000)
9292

93-
.. option:: <container>
93+
.. describe:: <container>
9494

9595
Container to list
9696

@@ -111,11 +111,11 @@ Save object locally
111111

112112
Destination filename (defaults to object name)
113113

114-
.. option:: <container>
114+
.. describe:: <container>
115115

116116
Download <object> from <container>
117117

118-
.. option:: <object>
118+
.. describe:: <object>
119119

120120
Object to save
121121

@@ -131,10 +131,10 @@ Display object details
131131
<container>
132132
<object>
133133
134-
.. option:: <container>
134+
.. describe:: <container>
135135

136136
Display <object> from <container>
137137

138-
.. option:: <object>
138+
.. describe:: <object>
139139

140140
Object to display

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ Delete role(s)
6767
os role delete
6868
<role> [<role> ...]
6969
70-
.. option:: <role>
70+
.. describe:: <role>
7171

7272
Role to delete (name or ID)
7373

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ server add security group
99

1010
Add security group to server
1111

12+
.. program:: server add security group
1213
.. code:: bash
1314
1415
os server add security group
@@ -28,6 +29,7 @@ server add volume
2829

2930
Add volume to server
3031

32+
.. program:: server add volume
3133
.. code:: bash
3234
3335
os server add volume
@@ -52,6 +54,7 @@ server create
5254

5355
Create a new server
5456

57+
.. program:: server create
5558
.. code:: bash
5659
5760
os server create
@@ -145,6 +148,7 @@ server delete
145148

146149
Delete server(s)
147150

151+
.. program:: server delete
148152
.. code:: bash
149153
150154
os server delete
@@ -223,6 +227,7 @@ server lock
223227

224228
Lock server
225229

230+
.. program:: server lock
226231
.. code:: bash
227232
228233
os server lock
@@ -237,6 +242,7 @@ server migrate
237242

238243
Migrate server to different host
239244

245+
.. program:: server migrate
240246
.. code:: bash
241247
242248
os server migrate
@@ -279,6 +285,7 @@ server pause
279285

280286
Pause server
281287

288+
.. program:: server pause
282289
.. code:: bash
283290
284291
os server pause
@@ -293,6 +300,7 @@ server reboot
293300

294301
Perform a hard or soft server reboot
295302

303+
.. program:: server reboot
296304
.. code:: bash
297305
298306
os server reboot
@@ -321,6 +329,7 @@ server rebuild
321329

322330
Rebuild server
323331

332+
.. program:: server rebuild
324333
.. code:: bash
325334
326335
os server rebuild
@@ -350,6 +359,7 @@ server remove security group
350359

351360
Remove security group from server
352361

362+
.. program:: server remove security group
353363
.. code:: bash
354364
355365
os server remove security group
@@ -369,6 +379,7 @@ server remove volume
369379

370380
Remove volume from server
371381

382+
.. program:: server remove volume
372383
.. code:: bash
373384
374385
os server remove volume
@@ -388,6 +399,7 @@ server rescue
388399

389400
Put server in rescue mode
390401

402+
.. program:: server rescure
391403
.. code:: bash
392404
393405
os server rescue
@@ -402,6 +414,7 @@ server resize
402414

403415
Scale server to a new flavor
404416

417+
.. program:: server resize
405418
.. code:: bash
406419
407420
os server resize
@@ -444,6 +457,7 @@ server resume
444457

445458
Resume server
446459

460+
.. program:: server resume
447461
.. code:: bash
448462
449463
os server resume
@@ -458,6 +472,7 @@ server set
458472

459473
Set server properties
460474

475+
.. program:: server set
461476
.. code:: bash
462477
463478
os server set
@@ -489,6 +504,7 @@ server show
489504

490505
Show server details
491506

507+
.. program:: server show
492508
.. code:: bash
493509
494510
os server show
@@ -508,6 +524,7 @@ server ssh
508524

509525
Ssh to server
510526

527+
.. program:: server ssh
511528
.. code:: bash
512529
513530
os server ssh
@@ -555,6 +572,7 @@ server suspend
555572

556573
Suspend server
557574

575+
.. program:: server suspend
558576
.. code:: bash
559577
560578
os server suspend
@@ -569,6 +587,7 @@ server unlock
569587

570588
Unlock server
571589

590+
.. program:: server unlock
572591
.. code:: bash
573592
574593
os server unlock
@@ -583,6 +602,7 @@ server unpause
583602

584603
Unpause server
585604

605+
.. program:: server unpause
586606
.. code:: bash
587607
588608
os server unpause
@@ -597,6 +617,7 @@ server unrescue
597617

598618
Restore server from rescue mode
599619

620+
.. program:: server unrescue
600621
.. code:: bash
601622
602623
os server unrescue
@@ -611,6 +632,7 @@ server unset
611632

612633
Unset server properties
613634

635+
.. program:: server unset
614636
.. code:: bash
615637
616638
os server unset

0 commit comments

Comments
 (0)