diff --git a/Doc/index.rst b/Doc/index.rst index 476e9cc..5142baa 100644 --- a/Doc/index.rst +++ b/Doc/index.rst @@ -1,10 +1,44 @@ -########################## -python-ldap Documentation -########################## +python-ldap +=========== + + +What is python-ldap? +-------------------- + +* python-ldap provides an object-oriented API to access LDAP + directory servers from `Python`_ programs. +* For LDAP operations the module wraps `OpenLDAP`_'s + client library *libldap* for that purpose. +* Additionally the package contains modules for other LDAP-related stuff: + + * LDIF + * LDAP URLs + * LDAPv3 subschema + +.. _Python: https://www.python.org/ +.. _OpenLDAP: https://www.openldap.org/ + + +Get it! +------- + +:ref:`Download information` is available for several platforms. + + +Mailing list +------------ + +Discussion about the use and future of Python-LDAP occurs in +the ``python-ldap@python.org`` mailing list. + +You can `subscribe or unsubscribe`_ to this list or browse the `list archive`_. + +.. _subscribe or unsubscribe: https://mail.python.org/mailman/listinfo/python-ldap +.. _list archive: https://mail.python.org/pipermail/python-ldap/ + -******** Contents -******** +-------- .. toctree:: :maxdepth: 2 @@ -13,10 +47,8 @@ Contents reference/index.rst - -********************* Bytes/text management -********************* +--------------------- The LDAP protocol states that some fields (distinguised names, relative distinguished names, attribute names, queries) be encoded in UTF-8; some other (mostly attribute *values*) **MAY** @@ -50,9 +82,8 @@ The typical usage is as follows; note that only the result's *values* are of the ] -****************** Indices and tables -****************** +------------------ * :ref:`genindex` * :ref:`modindex`