Browse Source

Fix documentation build issues

Nuwan Goonasekera 4 years ago
parent
commit
a13ff4efb7

+ 1 - 1
cloudbridge/interfaces/provider.py

@@ -67,7 +67,7 @@ class CloudProvider(object):
 
         :rtype: :class:`.MiddlewareManager`
         :return:  An object of class MiddlewareManager, which can be used to
-        add or remove middleware from cloudbridge.
+                  add or remove middleware from cloudbridge.
         """
         pass
 

+ 13 - 13
docs/api_docs/cloud/services.rst

@@ -4,7 +4,7 @@ Services
 .. contents:: :local:
 
 CloudService
----------------
+------------
 .. autoclass:: cloudbridge.interfaces.services.CloudService
     :members:
 
@@ -29,7 +29,7 @@ SnapshotService
     :members:
 
 StorageService
------------------
+--------------
 .. autoclass:: cloudbridge.interfaces.services.StorageService
     :members:
 
@@ -44,32 +44,32 @@ NetworkingService
     :members:
 
 NetworkService
------------------
+--------------
 .. autoclass:: cloudbridge.interfaces.services.NetworkService
     :members:
 
 SubnetService
------------------
+-------------
 .. autoclass:: cloudbridge.interfaces.services.SubnetService
     :members:
 
 FloatingIPService
 -----------------
-.. autoclass:: cloudbridge.interfaces.resources.FloatingIPSubService
+.. autoclass:: cloudbridge.interfaces.subservices.FloatingIPSubService
     :members:
 
 RouterService
------------------
+-------------
 .. autoclass:: cloudbridge.interfaces.services.RouterService
     :members:
 
 GatewayService
------------------
-.. autoclass:: cloudbridge.interfaces.resources.GatewaySubService
+--------------
+.. autoclass:: cloudbridge.interfaces.subservices.GatewaySubService
     :members:
 
 BucketService
----------------
+-------------
 .. autoclass:: cloudbridge.interfaces.services.BucketService
     :members:
 
@@ -84,7 +84,7 @@ KeyPairService
     :members:
 
 VMFirewallService
---------------------
+-----------------
 .. autoclass:: cloudbridge.interfaces.services.VMFirewallService
     :members:
 
@@ -99,16 +99,16 @@ RegionService
     :members:
 
 DnsService
--------------
+----------
 .. autoclass:: cloudbridge.interfaces.services.DnsService
     :members:
 
 DnsZoneService
--------------
+--------------
 .. autoclass:: cloudbridge.interfaces.services.DnsZoneService
     :members:
 
 DnsRecordService
--------------
+----------------
 .. autoclass:: cloudbridge.interfaces.services.DnsRecordService
     :members:

+ 1 - 0
docs/topics/overview.rst

@@ -16,5 +16,6 @@ Introductions to all the key parts of CloudBridge you'll need to know:
     Using block storage <block_storage.rst>
     Using object storage <object_storage.rst>
     Resource types and mapping <resource_types_and_mapping.rst>
+    Using the event system <event_system.rst>
     Troubleshooting <troubleshooting.rst>
     FAQ <faq.rst>

+ 1 - 1
docs/topics/setup.rst

@@ -212,7 +212,7 @@ OpenStack
 +-------------------------+--------------------------------------------------------------+
 | os_storage_url          | Storage endpoint URL, if applicable                          |
 +-------------------------+--------------------------------------------------------------+
-| os_project_domain_id    | Project domain id for authentication.                      |
+| os_project_domain_id    | Project domain id for authentication.                        |
 +-------------------------+--------------------------------------------------------------+
 | os_project_domain_name  | Project domain name for authentication.                      |
 +-------------------------+--------------------------------------------------------------+