rdataset and rrset doco structure

diff --git a/doc/rdata-set-classes.rst b/doc/rdata-set-classes.rst
new file mode 100644 (file)
index 0000000..5a953c8
--- /dev/null
+++ b/doc/rdata-set-classes.rst
@@ -0,0 +1,19 @@
+.. _rdata-set-classes:
+
+DNS Rdataset Class
+==================
+
+An ``Rdataset`` is a set of ``Rdata`` objects which all have the same
+rdatatype, rdataclass, and covered type.  ``Rdatasets`` also have a
+``ttl`` (DNS time-to-live) field.  Rdatasets support the normal Python
+set API, but are also ordered.
+
+An ``RRset`` is a subclass of ``Rdataset`` that also has an owner
+name, i.e. a ``dns.name.Name`` that says where in the DNS tree this
+set is located.
+
+.. autoclass:: dns.rdataset.Rdataset
+   :members:
+
+.. autoclass:: dns.rrset.RRset
+   :members:

diff --git a/doc/rdata-set-make.rst b/doc/rdata-set-make.rst
new file mode 100644 (file)
index 0000000..6ada9c3
--- /dev/null
+++ b/doc/rdata-set-make.rst
@@ -0,0 +1,13 @@
+.. _rdata-make:
+
+Making DNS Rdatasets and RRsets
+===============================
+
+.. autofunction:: dns.rdataset.from_text
+.. autofunction:: dns.rdataset.from_text_list
+.. autofunction:: dns.rdataset.from_rdata
+.. autofunction:: dns.rdataset.from_rdata_list
+.. autofunction:: dns.rrset.from_text
+.. autofunction:: dns.rrset.from_text_list
+.. autofunction:: dns.rrset.from_rdata
+.. autofunction:: dns.rrset.from_rdata_list

diff --git a/doc/rdata.rst b/doc/rdata.rst
index c304e052b8ed0d8d70cb20e45207c88f13245e41..3ac42179c67457909163a842e4838df5d7eff928 100644 (file)
--- a/doc/rdata.rst
+++ b/doc/rdata.rst
@@ -9,3 +9,5 @@ DNS Rdata
    rdata-class
    rdata-make
    rdata-subclasses
+   rdata-set-classes
+   rdata-set-make