diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-29 12:38:45 -0800 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-29 12:38:45 -0800 |
| commit | 4ce9c9e9af8cb494383d5cd188d822b07f6bf28b (patch) | |
| tree | 54f049674c651679fc7e1427f4731c26d77a6069 /docs/index.rst | |
| parent | eef972b17e72e9e7cd6f7aad5e89f39b8c44188e (diff) | |
| parent | b0293bf7ed069fc1469d098cc71b9c50b9080d25 (diff) | |
| download | cryptography-4ce9c9e9af8cb494383d5cd188d822b07f6bf28b.tar.gz cryptography-4ce9c9e9af8cb494383d5cd188d822b07f6bf28b.tar.bz2 cryptography-4ce9c9e9af8cb494383d5cd188d822b07f6bf28b.zip | |
Merge pull request #525 from skeuomorf/installation-docs
Added canonical installation document with details about various platforms
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 21 |
1 files changed, 4 insertions, 17 deletions
diff --git a/docs/index.rst b/docs/index.rst index b800bcaf..93b25ecf 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,29 +5,15 @@ Welcome to ``cryptography`` primitives. We hope it'll be your one-stop-shop for all your cryptographic needs in Python. -Installing ----------- - +Installation +------------ 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 - +see :doc:`Installation<installation>` for more information Why a new crypto library for Python? ------------------------------------ @@ -90,6 +76,7 @@ The ``cryptography`` open source project .. toctree:: :maxdepth: 2 + installation contributing security api-stability |