added doc stub for module slapdtest

ECN · Aug 1, 2017 · e17b11e · e17b11e
1 parent 83e2ec0
commit e17b11e
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/Doc/index.rst b/Doc/index.rst
@@ -2,7 +2,7 @@
 python-ldap Documentation
 ##########################
 
-.. % $Id: index.rst,v 1.9 2015/10/24 12:49:41 stroeder Exp $
+.. % $Id: index.rst,v 1.10 2017/08/01 17:50:24 stroeder Exp $
 
 .. topic:: Abstract
 
@@ -34,6 +34,7 @@ Contents
    ldif.rst
    ldapurl.rst
    dsml.rst
+   slapdtest.rst
 
 
 ******************

diff --git a/Doc/slapdtest.rst b/Doc/slapdtest.rst
@@ -0,0 +1,25 @@
+.. % $Id: slapdtest.rst,v 1.1 2017/08/01 17:50:24 stroeder Exp $
+
+#####################################
+:mod:`slapdtest` Spawning test instances of OpenLDAP's slapd server
+#####################################
+
+.. py:module:: slapdtest
+   :synopsis: Spawning test instances of OpenLDAP's slapd server
+.. moduleauthor:: python-ldap project (see https://www.python-ldap.org/)
+
+
+The module is used for testing python-ldap itself but can be used for 
+automatically testing any OpenLDAP-based configuration setup.
+
+This module is pure Python and does not rely on any non-standard modules.
+Therefore it can be used stand-alone without the rest of the python-ldap
+package.
+
+Functions
+^^^^^^^^^
+
+
+Classes
+^^^^^^^
+