Skip to content

Commit ee835e9

Browse files
committed
Merge pull request #1160 from tseaver/dns-add_api_docs
Add DNS API docs
2 parents b5c6085 + 5946e66 commit ee835e9

File tree

6 files changed

+44
-4
lines changed

6 files changed

+44
-4
lines changed

docs/dns-changes.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Change Sets
2+
~~~~~~~~~~~
3+
4+
.. automodule:: gcloud.dns.changes
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/dns-client.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
DNS Client
2+
==========
3+
4+
.. automodule:: gcloud.dns.client
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
Connection
10+
~~~~~~~~~~
11+
12+
.. automodule:: gcloud.dns.connection
13+
:members:
14+
:undoc-members:
15+
:show-inheritance:

docs/dns-resource_record_set.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Resource Record Sets
2+
~~~~~~~~~~~~~~~~~~~~
3+
4+
.. automodule:: gcloud.dns.resource_record_set
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/dns-zone.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Managed Zones
2+
~~~~~~~~~~~~~
3+
4+
.. automodule:: gcloud.dns.zone
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:

docs/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@
6464
:caption: DNS
6565

6666
dns-usage
67+
Client <dns-client>
68+
dns-zone
69+
dns-resource_record_set
70+
dns-changes
6771

6872
.. toctree::
6973
:maxdepth: 0

gcloud/dns/changes.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ def additions(self):
129129
"""Resource record sets to be added to the zone.
130130
131131
:rtype: sequence of
132-
:class:`gcloud.dns.resource_record_set.ResourceRecordSet'.
132+
:class:`gcloud.dns.resource_record_set.ResourceRecordSet`.
133133
:returns: record sets appended via :meth:`add_record_set`
134134
"""
135135
return self._additions
@@ -139,7 +139,7 @@ def deletions(self):
139139
"""Resource record sets to be deleted from the zone.
140140
141141
:rtype: sequence of
142-
:class:`gcloud.dns.resource_record_set.ResourceRecordSet'.
142+
:class:`gcloud.dns.resource_record_set.ResourceRecordSet`.
143143
:returns: record sets appended via :meth:`delete_record_set`
144144
"""
145145
return self._deletions
@@ -148,7 +148,7 @@ def add_record_set(self, record_set):
148148
"""Append a record set to the 'additions' for the change set.
149149
150150
:type record_set:
151-
:class:`gcloud.dns.resource_record_set.ResourceRecordSet'
151+
:class:`gcloud.dns.resource_record_set.ResourceRecordSet`
152152
:param record_set: the record set to append
153153
154154
:raises: ``ValueError`` if ``record_set`` is not of the required type.
@@ -161,7 +161,7 @@ def delete_record_set(self, record_set):
161161
"""Append a record set to the 'deletions' for the change set.
162162
163163
:type record_set:
164-
:class:`gcloud.dns.resource_record_set.ResourceRecordSet'
164+
:class:`gcloud.dns.resource_record_set.ResourceRecordSet`
165165
:param record_set: the record set to append
166166
167167
:raises: ``ValueError`` if ``record_set`` is not of the required type.

0 commit comments

Comments
 (0)