aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst18
-rw-r--r--docs/installation.rst24
2 files changed, 22 insertions, 20 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 73c40bf0..93b25ecf 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -5,6 +5,16 @@ Welcome to ``cryptography``
primitives. We hope it'll be your one-stop-shop for all your cryptographic
needs in Python.
+Installation
+------------
+You can install ``cryptography`` with ``pip``:
+
+.. code-block:: console
+
+ $ pip install cryptography
+
+see :doc:`Installation<installation>` for more information
+
Why a new crypto library for Python?
------------------------------------
@@ -40,13 +50,6 @@ 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
~~~~~~~~~~~~~~~~~
@@ -73,6 +76,7 @@ The ``cryptography`` open source project
.. toctree::
:maxdepth: 2
+ installation
contributing
security
api-stability
diff --git a/docs/installation.rst b/docs/installation.rst
index d9c30801..2206107e 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -11,19 +11,17 @@ Installation Notes
==================
On Windows
----------
-.. 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
+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
Using your own OpenSSL on Linux
-------------------------------