summaryrefslogtreecommitdiff
path: root/doc/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/index.rst')
-rw-r--r--doc/index.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..a63df87
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,27 @@
+Welcome to pyOpenSSL's documentation!
+=====================================
+
+.. topic:: Abstract
+
+ This module is a rather thin wrapper around (a subset of) the OpenSSL library.
+ With thin wrapper I mean that a lot of the object methods do nothing more than
+ calling a corresponding function in the OpenSSL library.
+
+
+Contents:
+
+.. toctree::
+ :maxdepth: 3
+
+ introduction
+ install
+ api
+ internals
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+