Updated Branches: refs/heads/trunk 369a16433 -> 662932e8e
docs: Add information on how to instantiate a HostVirtual driver. Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/b61e3118 Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/b61e3118 Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/b61e3118 Branch: refs/heads/trunk Commit: b61e3118187798262262c537231eceeec7e2dcee Parents: 369a164 Author: Tomaz Muraus <[email protected]> Authored: Mon Dec 30 14:12:54 2013 +0100 Committer: Tomaz Muraus <[email protected]> Committed: Mon Dec 30 14:12:54 2013 +0100 ---------------------------------------------------------------------- docs/dns/drivers/hostvirtual.rst | 18 ++++++++++++++++++ docs/dns/drivers/index.rst | 10 ++++++++++ .../dns/hostvirtual/instantiate_driver.py | 5 +++++ 3 files changed, 33 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/libcloud/blob/b61e3118/docs/dns/drivers/hostvirtual.rst ---------------------------------------------------------------------- diff --git a/docs/dns/drivers/hostvirtual.rst b/docs/dns/drivers/hostvirtual.rst new file mode 100644 index 0000000..56e5e01 --- /dev/null +++ b/docs/dns/drivers/hostvirtual.rst @@ -0,0 +1,18 @@ +HostVirtual DNS Driver Documentation +==================================== + +`Host Virtual`_ is is a cloud hosting provider that operates dual-stack IPv4 +and IPv6 IaaS clouds in 15 locations worldwide. + +Instantiating a driver +---------------------- + +When you instantiate a driver, you need to pass a single ``key`` argument to +the driver constructor. This argument represents your API secret key. + +For example: + +.. literalinclude:: /examples/dns/hostvirtual/instantiate_driver.py + :language: python + +.. _`Host Virtual`: https://www.hostvirtual.com/ http://git-wip-us.apache.org/repos/asf/libcloud/blob/b61e3118/docs/dns/drivers/index.rst ---------------------------------------------------------------------- diff --git a/docs/dns/drivers/index.rst b/docs/dns/drivers/index.rst new file mode 100644 index 0000000..970cccb --- /dev/null +++ b/docs/dns/drivers/index.rst @@ -0,0 +1,10 @@ +DNS Drivers Documentation +========================= + +This chapter includes links to driver (provider) specific documentation pages. + +.. toctree:: + :glob: + :maxdepth: 1 + + * http://git-wip-us.apache.org/repos/asf/libcloud/blob/b61e3118/docs/examples/dns/hostvirtual/instantiate_driver.py ---------------------------------------------------------------------- diff --git a/docs/examples/dns/hostvirtual/instantiate_driver.py b/docs/examples/dns/hostvirtual/instantiate_driver.py new file mode 100644 index 0000000..51aa0f7 --- /dev/null +++ b/docs/examples/dns/hostvirtual/instantiate_driver.py @@ -0,0 +1,5 @@ +from libcloud.dns.types import Provider +from libcloud.dns.providers import get_driver + +cls = get_driver(Provider.HOSTVIRTUAL) +driver = cls(key='my secret key')
