Add spelling options
authorBernardo Gonzalez Kriegel <bgkriegel@gmail.com>
Wed, 9 Nov 2016 14:29:41 +0000 (11:29 -0300)
committerChris Cormack <chrisc@catalyst.net.nz>
Wed, 9 Nov 2016 19:01:48 +0000 (08:01 +1300)
Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>

en/Makefile
en/source/conf.py
en/source/koha_spelling_wordlist.txt [new file with mode: 0644]

index bb03a6b..c900109 100644 (file)
@@ -43,6 +43,7 @@ help:
        @echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
        @echo "  coverage   to run coverage check of the documentation (if enabled)"
        @echo "  dummy      to check syntax errors of document sources"
+       @echo "  spelling   to check spelling errors of document sources"
 
 .PHONY: clean
 clean:
@@ -223,3 +224,9 @@ dummy:
        $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
        @echo
        @echo "Build finished. Dummy builder generates no files."
+
+.PHONY: spelling
+spelling:
+       $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
+       @echo
+       @echo "Spell check complete; look for any errors in $(BUILDDIR)/spelling/output.txt."
index 56fa653..83e140f 100644 (file)
@@ -35,8 +35,13 @@ extensions = [
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.coverage',
+    'sphinxcontrib.spelling',
 ]
 
+# Spelling options
+spelling_lang='en_US'
+spelling_word_list_filename='koha_spelling_wordlist.txt'
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
diff --git a/en/source/koha_spelling_wordlist.txt b/en/source/koha_spelling_wordlist.txt
new file mode 100644 (file)
index 0000000..96df287
--- /dev/null
@@ -0,0 +1,14 @@
+Koha
+wiki
+DocBook
+koha
+barcode
+Barcode
+OAuth
+google
+url
+cgi
+itemtype
+Esakov
+Camins
+biblio