Skip to content

Commit af7597a

Browse files
authored
Merge pull request #102 from flakjacket95/updated-docs
Fixed documentation Sphinx syntax errors
2 parents a7a8a66 + 9556a6a commit af7597a

File tree

10 files changed

+18
-15
lines changed

10 files changed

+18
-15
lines changed

doc/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ application’s PHP files:
2626
2727
require 'vendor/autoload.php';
2828
29-
This assumes your applications PHP files are located in the same folder as ``vendor/``. If your files are located
29+
This assumes your application's PHP files are located in the same folder as ``vendor/``. If your files are located
3030
elsewhere, please supply the path to vendor/autoload.php in the require statement above.
3131

3232
Supported services

doc/services/block-storage/v2/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Block Storage v2
22
================
33

44
.. toctree::
5-
:maxdepth: 3
5+
:maxdepth: 3
66

7-
volumes
8-
volume-types
9-
snapshots
7+
volumes
8+
volume-types
9+
snapshots
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Snapshots
2+
=========

doc/services/block-storage/v2/volume-types.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,10 @@ Volume Types
33

44
Listing volume types
55
--------------------
6-
76
.. sample:: block_storage/v2/volume_types/list.php
87
.. refdoc:: OpenStack/BlockStorage/v2/Service.html#method_listVolumeTypes
98

10-
Each iteration will return a :apiref:`VolumeType instance <OpenStack/BlockStorage/v2/Models/VolumeType.html>`.
9+
Each iteration will return a :php:class:`VolumeType` instance <OpenStack/BlockStorage/v2/Models/VolumeType.html>.
1110

1211
.. include:: /common/generators.rst
1312

doc/services/block-storage/v2/volumes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ List volumes
77
.. sample:: block_storage/v2/volumes/list.php
88
.. refdoc:: OpenStack/BlockStorage/v2/Service.html#method_listVolumes
99

10-
Each iteration will return a :apiref:`Volume instance <OpenStack/BlockStorage/v2/Models/Volume.html>`.
10+
Each iteration will return a php:class:`Volume` instance <OpenStack/BlockStorage/v2/Models/Volume.html>.
1111

1212
.. include:: /common/generators.rst
1313

doc/services/compute/v2/flavors.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ List flavors
77
.. sample:: compute/v2/flavors/list_flavors.php
88
.. refdoc:: OpenStack/Compute/v2/Service.html#method_listFlavors
99

10-
Each iteration will return a :apiref:`Flavor instance <OpenStack/Compute/v2/Models/Flavor.html>`.
10+
Each iteration will return a :php:class:`Flavor` instance <OpenStack/Compute/v2/Models/Flavor.html>.
1111

1212
.. include:: /common/generators.rst
1313

doc/services/compute/v2/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ Compute v2
66

77
servers
88
flavors
9-
images
9+
images
10+
states

doc/services/compute/v2/servers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ Create server image
273273
This operation will create a new server image. The only required option is the new image's name. You may also specify
274274
additional metadata:
275275

276-
.. sample:: compute/v2/servers/create_server_image.php
276+
.. sample:: compute/v2/images/create_server_image.php
277277
.. refdoc:: OpenStack/Compute/v2/Models/Server.html#method_createImage
278278

279279
List server IP addresses

doc/services/identity/v3/groups.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@ Groups
44
Add group
55
---------
66

7-
.. sample:: identity/v3/groups/add_endpoint.php
7+
.. sample:: identity/v3/groups/add_group.php
88
.. refdoc:: OpenStack/Identity/v3/Service.html#method_createGroup
99

1010
List groups
1111
-----------
1212

13-
.. sample:: identity/v3/groups/add_endpoint.php
13+
.. sample:: identity/v3/groups/list_groups.php
1414
.. refdoc:: OpenStack/Identity/v3/Service.html#method_listGroups
1515

1616
Show group details
1717
------------------
1818

19-
.. sample:: identity/v3/groups/add_endpoint.php
19+
.. sample:: identity/v3/groups/get_group.php
2020
.. refdoc:: OpenStack/Identity/v3/Service.html#method_getGroup
2121

2222
Update group

doc/services/networking/v2/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ Networking v2
55
:maxdepth: 3
66

77
networks
8-
subnets
8+
subnets
9+
ports

0 commit comments

Comments
 (0)