Merge pull request #1160 from tseaver/dns-add_api_docs

Add DNS API docs
googleapis · Sep 30, 2015 · ee835e9 · ee835e9
2 parents b5c6085 + 5946e66
commit ee835e9
Show file tree

Hide file tree

Showing 6 changed files with 44 additions and 4 deletions.
diff --git a/docs/dns-changes.rst b/docs/dns-changes.rst
@@ -0,0 +1,7 @@
+Change Sets
+~~~~~~~~~~~
+
+.. automodule:: gcloud.dns.changes
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/dns-client.rst b/docs/dns-client.rst
@@ -0,0 +1,15 @@
+DNS Client
+==========
+
+.. automodule:: gcloud.dns.client
+  :members:
+  :undoc-members:
+  :show-inheritance:
+
+Connection
+~~~~~~~~~~
+
+.. automodule:: gcloud.dns.connection
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/dns-resource_record_set.rst b/docs/dns-resource_record_set.rst
@@ -0,0 +1,7 @@
+Resource Record Sets
+~~~~~~~~~~~~~~~~~~~~
+
+.. automodule:: gcloud.dns.resource_record_set
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/dns-zone.rst b/docs/dns-zone.rst
@@ -0,0 +1,7 @@
+Managed Zones
+~~~~~~~~~~~~~
+
+.. automodule:: gcloud.dns.zone
+  :members:
+  :undoc-members:
+  :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -64,6 +64,10 @@
   :caption: DNS
 
   dns-usage
+  Client <dns-client>
+  dns-zone
+  dns-resource_record_set
+  dns-changes
 
 .. toctree::
   :maxdepth: 0

diff --git a/gcloud/dns/changes.py b/gcloud/dns/changes.py
@@ -129,7 +129,7 @@ def additions(self):
         """Resource record sets to be added to the zone.
 
         :rtype: sequence of
-                :class:`gcloud.dns.resource_record_set.ResourceRecordSet'.
+                :class:`gcloud.dns.resource_record_set.ResourceRecordSet`.
         :returns: record sets appended via :meth:`add_record_set`
         """
         return self._additions
@@ -139,7 +139,7 @@ def deletions(self):
         """Resource record sets to be deleted from the zone.
 
         :rtype: sequence of
-                :class:`gcloud.dns.resource_record_set.ResourceRecordSet'.
+                :class:`gcloud.dns.resource_record_set.ResourceRecordSet`.
         :returns: record sets appended via :meth:`delete_record_set`
         """
         return self._deletions
@@ -148,7 +148,7 @@ def add_record_set(self, record_set):
         """Append a record set to the 'additions' for the change set.
 
         :type record_set:
-            :class:`gcloud.dns.resource_record_set.ResourceRecordSet'
+            :class:`gcloud.dns.resource_record_set.ResourceRecordSet`
         :param record_set: the record set to append
 
         :raises: ``ValueError`` if ``record_set`` is not of the required type.
@@ -161,7 +161,7 @@ def delete_record_set(self, record_set):
         """Append a record set to the 'deletions' for the change set.
 
         :type record_set:
-            :class:`gcloud.dns.resource_record_set.ResourceRecordSet'
+            :class:`gcloud.dns.resource_record_set.ResourceRecordSet`
         :param record_set: the record set to append
 
         :raises: ``ValueError`` if ``record_set`` is not of the required type.