From: Bob Halley <halley@dnspython.org>
Date: Sun, 1 Jan 2017 14:51:31 +0000 (-0800)
Subject: more doc structure
X-Git-Tag: v1.16.0~105
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e1c3e9835229116ac93dc10d21d57ab73390ba2a;p=thirdparty%2Fdnspython.git

more doc structure
---

diff --git a/doc/community.rst b/doc/community.rst
new file mode 100644
index 00000000..3fb02e5e
--- /dev/null
+++ b/doc/community.rst
@@ -0,0 +1,17 @@
+.. _community:
+
+Community
+=========
+
+Bugs and Feature Requests
+-------------------------
+
+Bugs and feature requests can be made using the github issues system at
+`github <https://github.com/rthalley/dnspython/issues>`_.
+
+Mailing Lists
+-------------
+
+| `dnspython-announce <http://groups.google.com/group/dnspython-announce>`_
+| `dnspython-users <http://groups.google.com/group/dnspython-users>`_
+| `dnspython-dev <http://groups.google.com/group/dnspython-dev>`_
diff --git a/doc/index.rst b/doc/index.rst
index 4dbfcce1..33ce26a3 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -3,20 +3,29 @@
 dnspython
 =========
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
+Dnspython is a DNS toolkit for Python.  It can be used for queries,
+zone transfers, dynamic updates, nameserver testing, and many other
+things.
 
-   py2vs3.rst
-   name.rst
+Dnspython provides both high and low level access to the DNS. The high
+level classes perform queries for data of a given name, type, and
+class, and return an answer set. The low level classes allow direct
+manipulation of DNS zones, messages, names, and records.  Almost all
+RR types are supported.
+
+dnspython originated at Nominum where it was developed for testing DNS
+nameservers. Nominum has generously allowed it to be open sourced
+under a BSD-style license, and helps support its future development by
+continuing to employ the author.
 
 .. toctree::
-   :hidden:
+   :maxdepth: 1
+   :caption: Contents:
 
-   name-class.rst
-   name-make.rst
-   name-exceptions.rst
-   name-codecs.rst
+   whatsnew
+   community
+   installation
+   manual
 
 Indices and tables
 ==================
diff --git a/doc/installation.rst b/doc/installation.rst
new file mode 100644
index 00000000..d5c6634e
--- /dev/null
+++ b/doc/installation.rst
@@ -0,0 +1,54 @@
+.. _installation:
+
+Installation
+============
+
+Requirements
+------------
+
+Python 2.6 or later.
+
+Installation
+------------
+
+Many free operating system distributions have dnspython packaged for
+you, so you should check there first.
+
+The next easiest option is to use ``pip``::
+
+        pip install dnspython
+
+If ``pip`` is not available, you can download the latest zip file from
+`PyPI <https://pypi.python.org/pypi/dnspython/>`_, unzip it.
+
+On a UNIX-like system, you then run::
+
+        sudo python setup.py install
+
+while on a Windows system you would run::
+
+        python setup.py install
+        
+Finally, you have the option of cloning the dnspython source from github
+and building it::
+
+        git clone https://github.com/rthalley/dnspython.git
+
+And then run ``setup.py`` as above.
+
+Please be aware that the master branch of dnspython on github is under
+active development and may not always be stable.
+
+
+Optional Modules
+----------------
+
+The following modules are optional, but recommended for full functionality.
+
+If ``pycrypto`` is installed, then dnspython will be able to do
+low-level DNSSEC RSA and DSA signature validation.
+
+If ``ecdsa`` is installed, then Elliptic Curve signature algorithms will
+be available for low-level DNSSEC signature validation.
+
+If ``idna`` is installed, then IDNA 2008 will be available.
diff --git a/doc/manual.rst b/doc/manual.rst
new file mode 100644
index 00000000..5bf893a4
--- /dev/null
+++ b/doc/manual.rst
@@ -0,0 +1,10 @@
+Dnspython Manual
+================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   py2vs3
+   name
+
diff --git a/doc/name.rst b/doc/name.rst
index 92dd32ce..a2d01420 100644
--- a/doc/name.rst
+++ b/doc/name.rst
@@ -34,11 +34,9 @@ the ``fullcompare()`` method.  For example ```www.dnspython.org.`` is
 a subdomain of ``dnspython.org.``.  See the method description for
 full details.
 
-:ref:`name-class`
+.. toctree::
 
-:ref:`name-make`
-
-:ref:`name-exceptions`
-     
-:ref:`name-codecs`
-     
+   name-class
+   name-make
+   name-exceptions
+   name-codecs
diff --git a/doc/whatsnew.rst b/doc/whatsnew.rst
new file mode 100644
index 00000000..1fa5e5b5
--- /dev/null
+++ b/doc/whatsnew.rst
@@ -0,0 +1,11 @@
+.. _whatsnew:
+
+What's New in dnspython 1.16.0
+==============================
+
+New Features
+------------
+
+Bug Fixes
+---------
+