Переглянути джерело

Added quick reference with clickable svg.

nuwan_ag 10 роки тому
батько
коміт
23d561894a
3 змінених файлів з 12 додано та 4 видалено
  1. 1 1
      docs/concepts.rst
  2. 0 2
      docs/images/object_relationships_detailed.svg
  3. 11 1
      docs/index.rst

+ 1 - 1
docs/concepts.rst

@@ -31,7 +31,7 @@ Detailed class relationships
 The following diagram shows a typical provider object graph and the relationship
 The following diagram shows a typical provider object graph and the relationship
 between services.
 between services.
 
 
-.. image:: images/object_relationships_detailed.svg
+.. figure:: images/object_relationships_detailed.svg
 
 
 Some services are nested. For example, to access the instance service, you can
 Some services are nested. For example, to access the instance service, you can
 use `provider.compute.instances`. Similarly, to get a list of all instances,
 use `provider.compute.instances`. Similarly, to get a list of all instances,

Різницю між файлами не показано, бо вона завелика
+ 0 - 2
docs/images/object_relationships_detailed.svg


+ 11 - 1
docs/index.rst

@@ -1,4 +1,4 @@
-	.. cloudbridge documentation master file, created by
+.. cloudbridge documentation master file, created by
    sphinx-quickstart on Sat Oct 10 03:17:52 2015.
    sphinx-quickstart on Sat Oct 10 03:17:52 2015.
    You can adapt this file completely to your liking, but it should at least
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
    contain the root `toctree` directive.
@@ -26,6 +26,16 @@ look like the following.
 In the example above, the AWS_ACCESS_KEY and AWS_SECRET_KEY environment variables
 In the example above, the AWS_ACCESS_KEY and AWS_SECRET_KEY environment variables
 must be set to your cloud credentials.
 must be set to your cloud credentials.
 
 
+Quick Reference
+---------------
+
+The following object graph shows how to access various provider services, and the resource
+that they return. Click on any object to drill down into its details.
+
+.. raw:: html
+
+   <object data="_images/object_relationships_detailed.svg" type="image/svg+xml"></object>
+
 Installation
 Installation
 ------------
 ------------
 
 

Деякі файли не було показано, через те що забагато файлів було змінено