index.rst 808 B

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. =====================================
  2. Welcome to pyOpenSSL's documentation!
  3. =====================================
  4. Release v\ |release| (:doc:`What's new? <changelog>`).
  5. pyOpenSSL is a rather thin wrapper around (a subset of) the OpenSSL library.
  6. With thin wrapper we mean that a lot of the object methods do nothing more than
  7. calling a corresponding function in the OpenSSL library.
  8. Contents:
  9. =========
  10. .. toctree::
  11. :maxdepth: 2
  12. introduction
  13. install
  14. api
  15. internals
  16. There are also `examples in the pyOpenSSL repository <https://github.com/pyca/pyopenssl/tree/master/examples>`_ that may help you getting started.
  17. Meta
  18. ----
  19. .. toctree::
  20. :maxdepth: 1
  21. backward-compatibility
  22. changelog
  23. Indices and tables
  24. ==================
  25. * :ref:`genindex`
  26. * :ref:`modindex`
  27. * :ref:`search`