Clarified Windows development installation and docd upstream enchant bug (#3128)
* Clarified Windows development installation and doc'd upstream enchant bug
* Fixed whitespace problems
* Fixed merge resolution mistake
diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst
index 3ad9fe8..ea21f5e 100644
--- a/docs/development/getting-started.rst
+++ b/docs/development/getting-started.rst
@@ -6,18 +6,28 @@
Working on ``cryptography`` requires the installation of a small number of
development dependencies in addition to the dependencies for
:doc:`/installation`. These are listed in ``dev-requirements.txt`` and they can
-be installed in a `virtualenv`_ using `pip`_. Once you've installed the
-dependencies, install ``cryptography`` in ``editable`` mode. For example:
+be installed in a `virtualenv`_ using `pip`_. Before you install them, follow
+the **build** instructions in :doc:`/installation` (be sure to stop before
+actually installing ``cryptography``). Once you've done that, install the
+development dependencies, and then install ``cryptography`` in ``editable``
+mode. For example:
.. code-block:: console
$ # Create a virtualenv and activate it
+ $ # Set up your cryptography build environment
$ pip install --requirement dev-requirements.txt
$ pip install --editable .
You will also need to install ``enchant`` using your system's package manager
to check spelling in the documentation.
+.. note::
+ There is an upstream bug in ``enchant`` that prevents its installation on
+ Windows with 64-bit Python. See `this Github issue`_ for more information.
+ The easiest workaround is to use 32-bit Python for ``cryptography``
+ development, even on 64-bit Windows.
+
You are now ready to run the tests and build the documentation.
OpenSSL on OS X
@@ -42,7 +52,6 @@
.. tip::
You will also need to set these values when `Building documentation`_.
-
Running tests
-------------
@@ -118,3 +127,4 @@
.. _`pip`: https://pypi.python.org/pypi/pip
.. _`sphinx`: https://pypi.python.org/pypi/Sphinx
.. _`reStructured Text`: http://sphinx-doc.org/rest.html
+.. _`this Github issue`: https://github.com/rfk/pyenchant/issues/42
diff --git a/docs/installation.rst b/docs/installation.rst
index 330817c..2c60208 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -40,11 +40,12 @@
OpenSSL 1.0.0 is no longer supported by the OpenSSL project. Cryptography
will drop support for it in the next release.
-On Windows
-----------
+Building cryptography on Windows
+--------------------------------
The wheel package on Windows is a statically linked build (as of 0.5) so all
-dependencies are included. Just run
+dependencies are included. To install ``cryptography``, you will typically
+just run
.. code-block:: console