You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@libcloud.apache.org by to...@apache.org on 2013/12/18 18:51:17 UTC

[1/2] git commit: Use consistent docstring format.

Updated Branches:
  refs/heads/trunk f5584d8fc -> b66f49ae6


Use consistent docstring format.


Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/4d83eba0
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/4d83eba0
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/4d83eba0

Branch: refs/heads/trunk
Commit: 4d83eba0b9cfa6beecd4dddeaba5040aa5a7b4f0
Parents: f5584d8
Author: Tomaz Muraus <to...@apache.org>
Authored: Wed Dec 18 12:49:55 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Wed Dec 18 12:49:55 2013 +0100

----------------------------------------------------------------------
 libcloud/compute/drivers/cloudstack.py | 59 +++++++++++++++++++++--------
 1 file changed, 44 insertions(+), 15 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/4d83eba0/libcloud/compute/drivers/cloudstack.py
----------------------------------------------------------------------
diff --git a/libcloud/compute/drivers/cloudstack.py b/libcloud/compute/drivers/cloudstack.py
index b3dcb46..c2fed2f 100644
--- a/libcloud/compute/drivers/cloudstack.py
+++ b/libcloud/compute/drivers/cloudstack.py
@@ -32,19 +32,27 @@ from libcloud.utils.networking import is_private_subnet
 
 
 class CloudStackNode(Node):
-    "Subclass of Node so we can expose our extension methods."
+    """
+    Subclass of Node so we can expose our extension methods.
+    """
 
     def ex_allocate_public_ip(self):
-        "Allocate a public IP and bind it to this node."
+        """
+        Allocate a public IP and bind it to this node.
+        """
         return self.driver.ex_allocate_public_ip(self)
 
     def ex_release_public_ip(self, address):
-        "Release a public IP that this node holds."
+        """
+        Release a public IP that this node holds.
+        """
         return self.driver.ex_release_public_ip(self, address)
 
     def ex_create_ip_forwarding_rule(self, address, protocol,
                                      start_port, end_port=None):
-        "Add a NAT/firewall forwarding rule for a port or ports."
+        """
+        Add a NAT/firewall forwarding rule for a port or ports.
+        """
         return self.driver.ex_create_ip_forwarding_rule(node=self,
                                                         address=address,
                                                         protocol=protocol,
@@ -57,7 +65,9 @@ class CloudStackNode(Node):
                                        public_end_port=None,
                                        private_end_port=None,
                                        openfirewall=True):
-        "Add a port forwarding rule for port or ports."
+        """
+        Add a port forwarding rule for port or ports.
+        """
         return self.driver.ex_create_port_forwarding_rule(node=self,
                                                           address=
                                                           address,
@@ -74,24 +84,34 @@ class CloudStackNode(Node):
                                                           openfirewall)
 
     def ex_delete_ip_forwarding_rule(self, rule):
-        "Delete a port forwarding rule."
+        """
+        Delete a port forwarding rule.
+        """
         return self.driver.ex_delete_ip_forwarding_rule(node=self, rule=rule)
 
     def ex_delete_port_forwarding_rule(self, rule):
-        "Delete a NAT/firewall rule."
+        """
+        Delete a NAT/firewall rule.
+        """
         return self.driver.ex_delete_port_forwarding_rule(node=self, rule=rule)
 
     def ex_start(self):
-        "Starts a stopped virtual machine"
+        """
+        Starts a stopped virtual machine.
+        """
         return self.driver.ex_start(node=self)
 
     def ex_stop(self):
-        "Stops a running virtual machine"
+        """
+        Stops a running virtual machine.
+        """
         return self.driver.ex_stop(node=self)
 
 
 class CloudStackAddress(object):
-    "A public IP address."
+    """
+    A public IP address.
+    """
 
     def __init__(self, id, address, driver):
         self.id = id
@@ -109,7 +129,9 @@ class CloudStackAddress(object):
 
 
 class CloudStackIPForwardingRule(object):
-    "A NAT/firewall forwarding rule."
+    """
+    A NAT/firewall forwarding rule.
+    """
 
     def __init__(self, node, id, address, protocol, start_port, end_port=None):
         self.node = node
@@ -127,7 +149,9 @@ class CloudStackIPForwardingRule(object):
 
 
 class CloudStackPortForwardingRule(object):
-    "A Port forwarding rule for Source NAT."
+    """
+    A Port forwarding rule for Source NAT.
+    """
 
     def __init__(self, node, rule_id, address, protocol, public_port,
                  private_port, public_end_port=None, private_end_port=None):
@@ -181,7 +205,9 @@ class CloudStackPortForwardingRule(object):
 
 
 class CloudStackDiskOffering(object):
-    """A disk offering within CloudStack."""
+    """
+    A disk offering within CloudStack.
+    """
 
     def __init__(self, id, name, size, customizable):
         self.id = id
@@ -194,7 +220,9 @@ class CloudStackDiskOffering(object):
 
 
 class CloudStackNetwork(object):
-    """Class representing a CloudStack Network"""
+    """
+    Class representing a CloudStack Network.
+    """
 
     def __init__(self, displaytext, name, networkofferingid, id, zoneid,
                  driver):
@@ -213,7 +241,8 @@ class CloudStackNetwork(object):
 
 
 class CloudStackNodeDriver(CloudStackDriverMixIn, NodeDriver):
-    """Driver for the CloudStack API.
+    """
+    Driver for the CloudStack API.
 
     :cvar host: The host where the API can be reached.
     :cvar path: The path where the API can be reached.


[2/2] git commit: Use sphinxcontrib.fulltoc sphinx extension.

Posted by to...@apache.org.
Use sphinxcontrib.fulltoc sphinx extension.


Project: http://git-wip-us.apache.org/repos/asf/libcloud/repo
Commit: http://git-wip-us.apache.org/repos/asf/libcloud/commit/b66f49ae
Tree: http://git-wip-us.apache.org/repos/asf/libcloud/tree/b66f49ae
Diff: http://git-wip-us.apache.org/repos/asf/libcloud/diff/b66f49ae

Branch: refs/heads/trunk
Commit: b66f49ae6022976326d9183d3fe7174e3db3a3ee
Parents: 4d83eba
Author: Tomaz Muraus <to...@apache.org>
Authored: Wed Dec 18 18:24:06 2013 +0100
Committer: Tomaz Muraus <to...@apache.org>
Committed: Wed Dec 18 18:24:06 2013 +0100

----------------------------------------------------------------------
 docs/conf.py          | 2 +-
 requirements-docs.txt | 1 +
 tox.ini               | 1 +
 3 files changed, 3 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/libcloud/blob/b66f49ae/docs/conf.py
----------------------------------------------------------------------
diff --git a/docs/conf.py b/docs/conf.py
index bc1ff23..247b3c4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -26,7 +26,7 @@ sys.path.insert(0, os.path.abspath('../'))
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
-              'sphinx.ext.viewcode']
+              'sphinx.ext.viewcode', 'sphinxcontrib.fulltoc']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

http://git-wip-us.apache.org/repos/asf/libcloud/blob/b66f49ae/requirements-docs.txt
----------------------------------------------------------------------
diff --git a/requirements-docs.txt b/requirements-docs.txt
new file mode 100644
index 0000000..83ecab7
--- /dev/null
+++ b/requirements-docs.txt
@@ -0,0 +1 @@
+sphinxcontrib-fulltoc==1.0

http://git-wip-us.apache.org/repos/asf/libcloud/blob/b66f49ae/tox.ini
----------------------------------------------------------------------
diff --git a/tox.ini b/tox.ini
index 6caeed9..b98c1a3 100644
--- a/tox.ini
+++ b/tox.ini
@@ -40,6 +40,7 @@ deps = mock
 
 [testenv:docs]
 deps = sphinx
+       sphinxcontrib.fulltoc
 basepython = python2.7
 changedir = docs
 commands = python ../contrib/generate_provider_feature_matrix_table.py