Skip to content

Add DNS API docs #1160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 30, 2015
Merged

Add DNS API docs #1160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a75c076
Fix ReST rendering in docstrings.
tseaver Sep 30, 2015
5946e66
Add DNS API docs.
tseaver Sep 30, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/dns-changes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Change Sets
~~~~~~~~~~~

.. automodule:: gcloud.dns.changes
:members:
:undoc-members:
:show-inheritance:
15 changes: 15 additions & 0 deletions docs/dns-client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
7 changes: 7 additions & 0 deletions docs/dns-resource_record_set.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Resource Record Sets
~~~~~~~~~~~~~~~~~~~~

.. automodule:: gcloud.dns.resource_record_set
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/dns-zone.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Managed Zones
~~~~~~~~~~~~~

.. automodule:: gcloud.dns.zone
:members:
:undoc-members:
:show-inheritance:
4 changes: 4 additions & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,10 @@
:caption: DNS

dns-usage
Client <dns-client>
dns-zone
dns-resource_record_set
dns-changes

.. toctree::
:maxdepth: 0
Expand Down
8 changes: 4 additions & 4 deletions gcloud/dns/changes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand Down