diff options
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/getting-started.rst | 16 |
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst index 3ad9fe82..ea21f5e6 100644 --- a/docs/development/getting-started.rst +++ b/docs/development/getting-started.rst @@ -6,18 +6,28 @@ Development dependencies 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 @@ absolute path for the `OpenSSL`_ libraries before calling pip. .. tip:: You will also need to set these values when `Building documentation`_. - Running tests ------------- @@ -118,3 +127,4 @@ The HTML documentation index can now be found at .. _`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 |