diff options
| author | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-29 17:10:51 -0600 |
|---|---|---|
| committer | Paul Kehrer <paul.l.kehrer@gmail.com> | 2014-01-29 17:10:51 -0600 |
| commit | 0216d60e083bac29b8a8b699ea1c1eb1002b58e9 (patch) | |
| tree | a270ccbb6ff3fce046ab8cf992a376340776e381 /docs/index.rst | |
| parent | 0bf1f138d5a504ddf07279c42632702265090f76 (diff) | |
| parent | b2ff87737ca27a171ce0034e100841782d19dd7b (diff) | |
| download | cryptography-0216d60e083bac29b8a8b699ea1c1eb1002b58e9.tar.gz cryptography-0216d60e083bac29b8a8b699ea1c1eb1002b58e9.tar.bz2 cryptography-0216d60e083bac29b8a8b699ea1c1eb1002b58e9.zip | |
Merge branch 'master' into pbkdf2-commoncrypto
* master:
a bit more language work + changelog changes for pbkdf2hmac
one more style fix
a few typo fixes, capitalization, etc
switch to private attributes in pbkdf2hmac
expand docs to talk more about the purposes of KDFs
update docs re: PBKDF2HMAC iterations
add test for null char replacement
Added installation section to index.rst
called -> used
quotes inside, diff examples
Expose this method because probably someone will need it eventually
fix spacing, remove versionadded since HashAlgorithm was in 0.1
document HashAlgorithm
Added canonical installation document with details about various platforms, fixes #519
update docs for pbkdf2
Add bindings for X509_REQ_get_extensions.
add Konstantinos Koukopoulos to AUTHORS.rst
review fixes
doc updates based on review
Conflicts:
docs/changelog.rst
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..86cd42c6 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 |