2
0
Karl Hobley 10 жил өмнө
parent
commit
27facef89e
3 өөрчлөгдсөн 16 нэмэгдсэн , 0 устгасан
  1. 5 0
      docs/Makefile
  2. 7 0
      docs/conf.py
  3. 4 0
      requirements-dev.txt

+ 5 - 0
docs/Makefile

@@ -54,6 +54,11 @@ html:
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+spelling:
+	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
+	@echo
+	@echo "Spellcheck complete."
+
 dirhtml:
 	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
 	@echo

+ 7 - 0
docs/conf.py

@@ -50,6 +50,7 @@ os.environ['DATABASE_ENGINE'] = 'django.db.backends.sqlite3'
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
+    'sphinxcontrib.spelling',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -116,6 +117,12 @@ pygments_style = 'sphinx'
 #keep_warnings = False
 
 
+# splhinxcontrib.spelling settings
+
+spelling_lang = 'en_US'
+spelling_word_list_filename='spelling_wordlist.txt'
+
+
 # -- Options for HTML output ----------------------------------------------
 
 

+ 4 - 0
requirements-dev.txt

@@ -7,3 +7,7 @@ Pillow>=2.7.0
 # For coverage and PEP8 linting
 coverage>=3.7.0
 flake8>=2.2.0
+
+# For spellchecking the documentation
+sphinxcontrib-spelling==2.1.1
+pyenchant==1.6.6