summaryrefslogtreecommitdiff
path: root/doc/api.rst
diff options
context:
space:
mode:
authorJonathan Ballet <jon@multani.info>2011-07-17 22:56:05 +0900
committerJonathan Ballet <jon@multani.info>2011-07-17 22:56:05 +0900
commitc9e066c5d4d76d3509e43f50f3be60370b53d151 (patch)
treea9559f9240277dbb0aec4212b3fbd21f6beb6e56 /doc/api.rst
parentc7b7ba7b2b512033f8f875a6160bf727f535f5ab (diff)
downloadpyopenssl-git-c9e066c5d4d76d3509e43f50f3be60370b53d151.tar.gz
Translate the Latex doc to Sphinx doc
Don't rely on the docstrings anymor, which aren't sufficient anyway to generate this kind of documentation.
Diffstat (limited to 'doc/api.rst')
-rw-r--r--doc/api.rst15
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/api.rst b/doc/api.rst
index bcebd43..55a33ec 100644
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -1,7 +1,14 @@
-API
-===
+.. py:module:: OpenSSL
-.. automodule:: OpenSSL
+
+.. _api-openssl:
+
+
+OpenSSL -- Python interface to OpenSSL
+======================================
+
+This package provides a high-level interface to the functions in the
+OpenSSL library. The following modules are defined:
.. toctree::
@@ -9,4 +16,4 @@ API
api/crypto
api/rand
- api/SSL
+ api/ssl