docs: Use ":class:" when referencing a class in the terminology section.
Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/1e66bb4c Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/1e66bb4c Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/1e66bb4c Branch: refs/heads/trunk Commit: 1e66bb4c58beba70ba49f35314da8342d54dc421 Parents: 03f962c Author: Tomaz Muraus <[email protected]> Authored: Sun Dec 8 23:29:02 2013 +0100 Committer: Tomaz Muraus <[email protected]> Committed: Sun Dec 8 23:29:02 2013 +0100 ---------------------------------------------------------------------- docs/compute/index.rst | 26 ++++++++++++++++---------- docs/dns/index.rst | 12 ++++++------ docs/loadbalancer/index.rst | 10 ++++++---- docs/storage/index.rst | 11 ++++++----- 4 files changed, 34 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/1e66bb4c/docs/compute/index.rst ---------------------------------------------------------------------- diff --git a/docs/compute/index.rst b/docs/compute/index.rst index 836925b..e142522 100644 --- a/docs/compute/index.rst +++ b/docs/compute/index.rst @@ -22,20 +22,26 @@ Terminology Compute ~~~~~~~ -* **Node** - represents a cloud or virtual server. -* **NodeSize** - represents node hardware configuration. Usually this is amount - of the available RAM, bandwidth, CPU speed and disk size. Most of the drivers - also expose hourly price (in dollars) for the Node of this size. -* **NodeImage** - represents an operating system image. -* **NodeLocation** - represents a physical location where a server can be. -* **NodeState** - represents a node state. Standard states are: ``running``, - ``stopped``, ``rebooting``, ``terminated``, ``pending``, and ``unknown``. +* :class:`~libcloud.compute.base.Node` - represents a cloud or virtual server. +* :class:`~libcloud.compute.base.NodeSize` - represents node hardware + configuration. Usually this is amount of the available RAM, bandwidth, + CPU speed and disk size. Most of the drivers also expose an hourly price + (in dollars) for the Node of this size. +* :class:`~libcloud.compute.base.NodeImage` - represents an operating system + image. +* :class:`~libcloud.compute.base.NodeLocation` - represents a physical location + where a server can be. +* :class:`~libcloud.compute.types.NodeState` - represents a node state. + Standard states are: ``running``, ``stopped``, ``rebooting``, ``terminated``, + ``pending``, and ``unknown``. Block Storage ~~~~~~~~~~~~~ -* **StorageVolume** - represents a block storage volume -* **VolumeSnapshot** - represents a point in time snapshot of a StorageVolume +* :class:`~libcloud.compute.base.StorageVolume` - represents a block storage + volume +* :class:`~libcloud.compute.base.VolumeSnapshot` - represents a point in time + snapshot of a StorageVolume Supported Providers ------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/1e66bb4c/docs/dns/index.rst ---------------------------------------------------------------------- diff --git a/docs/dns/index.rst b/docs/dns/index.rst index 7580cfe..3f9af19 100644 --- a/docs/dns/index.rst +++ b/docs/dns/index.rst @@ -11,16 +11,16 @@ Rackspace Cloud DNS and others. Terminology ----------- -* **Zone** - Represents a DNS zone or so called domain. -* **Record** - Represents a DNS record. Each record belongs to a Zone and has - a ``type`` and ``data`` attribute. Value of the ``data`` attribute depends on - the record type. +* :class:`~libcloud.dns.base.Zone` - Represents a DNS zone or so called domain. +* :class:`~libcloud.dns.base.Record` - Represents a DNS record. Each record + belongs to a Zone and has a ``type`` and ``data`` attribute. Value of the + ``data`` attribute depends on the record type. Some record types also require user to associate additional attributes with them. Those additional attributes are stored in the ``extra`` attribute (dictionary) on the record object. An example include ``MX`` and ``SRV`` record type which also contains a priority. -* **RecordType** - Represents a DNS record type (``A``, ``AAAA``, ``MX``, - ``TXT``, ``SRV``, ``PTR``, ``NS``, etc.) +* :class:`~libcloud.dns.types.RecordType` - Represents a DNS record type + (``A``, ``AAAA``, ``MX``, ``TXT``, ``SRV``, ``PTR``, ``NS``, etc.) * **Zone Type** - Each zone has a ``type`` attribute. This attribute represents a zone type. Type can either be ``master`` (also called primary) or ``slave`` (also called secondary). http://git-wip-us.apache.org/repos/asf/libcloud/blob/1e66bb4c/docs/loadbalancer/index.rst ---------------------------------------------------------------------- diff --git a/docs/loadbalancer/index.rst b/docs/loadbalancer/index.rst index f432017..fd68114 100644 --- a/docs/loadbalancer/index.rst +++ b/docs/loadbalancer/index.rst @@ -12,10 +12,12 @@ Balancers. Terminology ----------- -* **LoadBalancer** - represents a load balancer instance. -* **Member** - represents a load balancer member. -* **Algorithm** - represents a load balancing algorithm (round-robin, random, - least connections, etc.). +* :class:`~libcloud.loadbalancer.base.LoadBalancer` - represents a load + balancer instance. +* :class:`~libcloud.loadbalancer.base.Member` - represents a load balancer + member. +* :class:`~libcloud.loadbalancer.base.Algorithm` - represents a load balancing + algorithm (round-robin, random, least connections, etc.). Supported Providers ------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/1e66bb4c/docs/storage/index.rst ---------------------------------------------------------------------- diff --git a/docs/storage/index.rst b/docs/storage/index.rst index fe1042d..4eba053 100644 --- a/docs/storage/index.rst +++ b/docs/storage/index.rst @@ -15,11 +15,12 @@ CDN management functionality. Terminology ----------- -* **Object** - represents an object or so called BLOB. -* **Container** - represents a container which can contain multiple objects. - You can think of it as a folder on a file system. Difference between - container and a folder on file system is that containers cannot be nested. - Some APIs and providers (e.g. AWS) refer to it as a Bucket. +* :class:`~libcloud.storage.base.Container` - represents a container which can + contain multiple objects. You can think of it as a folder on a file system. + Difference between container and a folder on file system is that containers + cannot be nested. Some APIs and providers (e.g. AWS) refer to it as a Bucket. +* :class:`~libcloud.storage.base.Object` - represents an object or so called + BLOB. Supported Providers -------------------
