diff --git a/doc/Makefile b/doc/Makefile index f423c2f..535ebbd 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -19,7 +19,7 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . # the i18n builder cannot share the environment and doctrees with the others I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext spelling help: @echo "Please use \`make ' where is one of" @@ -45,6 +45,7 @@ help: @echo " pseudoxml to make pseudoxml-XML files for display purposes" @echo " linkcheck to check all external links for integrity" @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " spelling to run the spellchecker" clean: rm -rf $(BUILDDIR)/* @@ -175,3 +176,8 @@ pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +spelling: + $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling + @echo + @echo "Spellchecker finished." diff --git a/doc/conf.py b/doc/conf.py index 2cbe0cf..b83629e 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -43,6 +43,7 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.graphviz', 'sphinx.ext.inheritance_diagram', + 'sphinxcontrib.spelling', ] # supress warnings for external images diff --git a/doc/requirements.txt b/doc/requirements.txt index 89cd833..c0050c9 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -5,4 +5,5 @@ pyserial sphinx-rtd-theme setuptools-scm docutils>=0.12 +sphinxcontrib-spelling>=5 python-barcode>=0.11.0,<1 diff --git a/doc/spelling_wordlist.txt b/doc/spelling_wordlist.txt new file mode 100644 index 0000000..e69de29 diff --git a/setup.cfg b/setup.cfg index 10e0396..567e548 100644 --- a/setup.cfg +++ b/setup.cfg @@ -59,6 +59,7 @@ tests_require = mock hypothesis>4 flake8 + sphinxcontrib-spelling>=5 [nosetests] verbosity=3