| Hynek Schlawack | 8fb864a | 2015-06-07 19:09:49 +0200 | [diff] [blame] | 1 | ===================================== |
| Jonathan Ballet | 0646a24 | 2011-07-16 07:13:03 +0900 | [diff] [blame] | 2 | Welcome to pyOpenSSL's documentation! |
| 3 | ===================================== |
| 4 | |
| Hynek Schlawack | 682443f | 2015-10-25 16:15:12 +0100 | [diff] [blame] | 5 | Release v\ |release| (:doc:`What's new? <changelog>`). |
| Jonathan Ballet | 6381da3 | 2011-07-20 16:43:38 +0900 | [diff] [blame] | 6 | |
| Hynek Schlawack | 8fb864a | 2015-06-07 19:09:49 +0200 | [diff] [blame] | 7 | pyOpenSSL is a rather thin wrapper around (a subset of) the OpenSSL library. |
| 8 | With thin wrapper we mean that a lot of the object methods do nothing more than |
| 9 | calling a corresponding function in the OpenSSL library. |
| Jonathan Ballet | 6381da3 | 2011-07-20 16:43:38 +0900 | [diff] [blame] | 10 | |
| Jonathan Ballet | add44ae | 2011-07-16 14:39:36 +0900 | [diff] [blame] | 11 | |
| Jonathan Ballet | 0646a24 | 2011-07-16 07:13:03 +0900 | [diff] [blame] | 12 | Contents: |
| Hynek Schlawack | 8fb864a | 2015-06-07 19:09:49 +0200 | [diff] [blame] | 13 | ========= |
| Jonathan Ballet | 0646a24 | 2011-07-16 07:13:03 +0900 | [diff] [blame] | 14 | |
| 15 | .. toctree:: |
| Hynek Schlawack | 8fb864a | 2015-06-07 19:09:49 +0200 | [diff] [blame] | 16 | :maxdepth: 2 |
| Jonathan Ballet | 0646a24 | 2011-07-16 07:13:03 +0900 | [diff] [blame] | 17 | |
| Jonathan Ballet | add44ae | 2011-07-16 14:39:36 +0900 | [diff] [blame] | 18 | introduction |
| Hynek Schlawack | 8fb864a | 2015-06-07 19:09:49 +0200 | [diff] [blame] | 19 | install |
| Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 20 | api |
| Jonathan Ballet | c7b7ba7 | 2011-07-16 15:29:47 +0900 | [diff] [blame] | 21 | internals |
| Jonathan Ballet | 648875f | 2011-07-16 14:14:58 +0900 | [diff] [blame] | 22 | |
| Hynek Schlawack | 8b7e455 | 2016-03-13 07:51:09 +0100 | [diff] [blame] | 23 | There are also `examples in the pyOpenSSL repository <https://github.com/pyca/pyopenssl/tree/master/examples>`_ that may help you getting started. |
| 24 | |
| Hynek Schlawack | 8fb864a | 2015-06-07 19:09:49 +0200 | [diff] [blame] | 25 | |
| Hynek Schlawack | 682443f | 2015-10-25 16:15:12 +0100 | [diff] [blame] | 26 | Meta |
| 27 | ---- |
| 28 | |
| 29 | .. toctree:: |
| 30 | :maxdepth: 1 |
| 31 | |
| 32 | backward-compatibility |
| 33 | changelog |
| 34 | |
| 35 | |
| Jonathan Ballet | 0646a24 | 2011-07-16 07:13:03 +0900 | [diff] [blame] | 36 | Indices and tables |
| 37 | ================== |
| 38 | |
| 39 | * :ref:`genindex` |
| 40 | * :ref:`modindex` |
| 41 | * :ref:`search` |