summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorSzczepan Cieślik <szczepan.cieslik@gmail.com>2014-02-22 18:46:31 +0100
committerTim Graham <timograham@gmail.com>2014-03-07 09:29:23 -0500
commita0f252520291924f8fb7cb0d85f1680294508560 (patch)
treeb96dcaf239a80e3d0869381c36b080b609ee7d11 /docs/conf.py
parent8f9c3d05650cd418c57f2ded49ed1acbb5c05e77 (diff)
Fixed #22141 -- Added a spelling checker for documentation.
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index ff919a6265..f10354f244 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -33,6 +33,17 @@ needs_sphinx = '1.0'
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ["djangodocs", "sphinx.ext.intersphinx"]
+# Spelling check needs an additional module that is not installed by default.
+# Add it only if spelling check is requested so docs can be generated without it.
+if 'spelling' in sys.argv:
+ extensions.append("sphinxcontrib.spelling")
+
+# Spelling language.
+spelling_lang = 'en_US'
+
+# Location of word list.
+spelling_word_list_filename = 'spelling_wordlist'
+
# Add any paths that contain templates here, relative to this directory.
# templates_path = []