summaryrefslogtreecommitdiff
path: root/contrib/python/docs/source/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'contrib/python/docs/source/index.rst')
-rw-r--r--contrib/python/docs/source/index.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/contrib/python/docs/source/index.rst b/contrib/python/docs/source/index.rst
new file mode 100644
index 0000000..d00b639
--- /dev/null
+++ b/contrib/python/docs/source/index.rst
@@ -0,0 +1,22 @@
+PyLDNS documentation
+=======================================
+
+PyLDNS provides an `LDNS`_ wrapper (Python extension module) - the thinnest layer over the library possible. Everything you can do from the C API, you can do from Python, but with less effort. The purpose of porting LDNS library to Python is to simplify DNS programming and usage of LDNS, however, still preserve the performance of this library as the speed represents the main benefit of LDNS. The proposed object approach allows the users to be concentrated at the essential part of application only and don't bother with deallocation of objects and so on.
+
+.. _LDNS: http://www.nlnetlabs.nl/projects/ldns/
+
+Contents
+----------
+.. toctree::
+ :maxdepth: 2
+
+ install.rst
+ examples/index.rst
+ modules/ldns
+
+Indices and tables
+-------------------
+
+* :ref:`genindex`
+* :ref:`search`
+