diff options
| author | skeuomorf <skeuomorf@gmail.com> | 2014-01-29 08:31:47 +0200 |
|---|---|---|
| committer | skeuomorf <skeuomorf@gmail.com> | 2014-01-29 19:22:31 +0200 |
| commit | bc26efb3668a3f66fd13a6a8d3ef72f91e11af8e (patch) | |
| tree | d8e58d3ccd7c3abc6ef9cd932e59aac25f9a4d99 /docs/index.rst | |
| parent | 79777fbfb521154cae072f75970aa53099835edd (diff) | |
| download | cryptography-bc26efb3668a3f66fd13a6a8d3ef72f91e11af8e.tar.gz cryptography-bc26efb3668a3f66fd13a6a8d3ef72f91e11af8e.tar.bz2 cryptography-bc26efb3668a3f66fd13a6a8d3ef72f91e11af8e.zip | |
Added canonical installation document with details about various platforms, fixes #519
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 31 |
1 files changed, 7 insertions, 24 deletions
diff --git a/docs/index.rst b/docs/index.rst index b800bcaf..73c40bf0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,30 +5,6 @@ Welcome to ``cryptography`` primitives. We hope it'll be your one-stop-shop for all your cryptographic needs in Python. -Installing ----------- - -You can install ``cryptography`` with ``pip``: - -.. code-block:: console - - $ pip install cryptography - -.. note:: - - If you're on Windows you'll need to make sure you have OpenSSL installed. - There are `pre-compiled binaries`_ available. If your installation is in - an unusual location set the ``LIB`` and ``INCLUDE`` environment variables - to include the corresponding locations. For example: - - .. code-block:: console - - C:\> \path\to\vcvarsall.bat x86_amd64 - C:\> set LIB=C:\OpenSSL-1.0.1f-64bit\lib;%LIB% - C:\> set INCLUDE=C:\OpenSSL-1.0.1f-64bit\include;%INCLUDE% - C:\> pip install cryptography - - Why a new crypto library for Python? ------------------------------------ @@ -64,6 +40,13 @@ admonition at the top. We recommend using the recipes layer whenever possible, and falling back to the hazmat layer only when necessary. +Installation +~~~~~~~~~~~~ +.. toctree:: + :maxdepth: 2 + + installation + The recipes layer ~~~~~~~~~~~~~~~~~ |