aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Gaynor <alex.gaynor@gmail.com>2014-06-27 12:41:35 -0700
committerAlex Gaynor <alex.gaynor@gmail.com>2014-06-27 12:41:35 -0700
commit9371dbfbaa61b17b6996c6fe43ee426e3092af04 (patch)
tree44e169ad65a68303957343fd6e5e1e2f8944822f
parent921b7b3fd1f654f6dce9ef1a7762b9f410be4d2e (diff)
parent2ac87783eea1543582a11dcdd71fa555eb9f858b (diff)
downloadcryptography-9371dbfbaa61b17b6996c6fe43ee426e3092af04.tar.gz
cryptography-9371dbfbaa61b17b6996c6fe43ee426e3092af04.tar.bz2
cryptography-9371dbfbaa61b17b6996c6fe43ee426e3092af04.zip
Merge pull request #1188 from reaperhulk/fix-1167
add note about enchant dependency for spellcheck in docs
-rw-r--r--docs/development/getting-started.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/development/getting-started.rst b/docs/development/getting-started.rst
index db34cb92..f5d6c190 100644
--- a/docs/development/getting-started.rst
+++ b/docs/development/getting-started.rst
@@ -13,6 +13,9 @@ dependencies, install ``cryptography`` in ``editable`` mode. For example:
$ 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.
+
You are now ready to run the tests and build the documentation.
Running tests