Enabled sphinxcontrib.spelling
authorEriol
Fri, 14 Dec 2012 06:36:28 +0100
changeset 82598d6a459d59
parent 81 94bbc0ff69b5
child 83 1c2250de1c17
Enabled sphinxcontrib.spelling
docs/Makefile
docs/conf.py
     1.1 --- a/docs/Makefile	Fri Dec 14 06:13:14 2012 +0100
     1.2 +++ b/docs/Makefile	Fri Dec 14 06:36:28 2012 +0100
     1.3 @@ -12,7 +12,7 @@
     1.4  PAPEROPT_letter = -D latex_paper_size=letter
     1.5  ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
     1.6  
     1.7 -.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
     1.8 +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest spelling
     1.9  
    1.10  help:
    1.11  	@echo "Please use \`make <target>' where <target> is one of"
    1.12 @@ -32,6 +32,7 @@
    1.13  	@echo "  changes    to make an overview of all changed/added/deprecated items"
    1.14  	@echo "  linkcheck  to check all external links for integrity"
    1.15  	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
    1.16 +	@echo "  spelling   to check spelling using sphinxcontrib.spelling"
    1.17  
    1.18  clean:
    1.19  	-rm -rf $(BUILDDIR)/*
    1.20 @@ -128,3 +129,9 @@
    1.21  	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
    1.22  	@echo "Testing of doctests in the sources finished, look at the " \
    1.23  	      "results in $(BUILDDIR)/doctest/output.txt."
    1.24 +
    1.25 +spelling:
    1.26 +	$(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/spelling
    1.27 +	@echo
    1.28 +	@echo "Spelling check complete; look for any errors in the above output " \
    1.29 +	      "or in $(BUILDDIR)/spelling/output.txt."
     2.1 --- a/docs/conf.py	Fri Dec 14 06:13:14 2012 +0100
     2.2 +++ b/docs/conf.py	Fri Dec 14 06:36:28 2012 +0100
     2.3 @@ -25,7 +25,7 @@
     2.4  
     2.5  # Add any Sphinx extension module names here, as strings. They can be extensions
     2.6  # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
     2.7 -extensions = []
     2.8 +extensions = ['sphinxcontrib.spelling']
     2.9  
    2.10  # Add any paths that contain templates here, relative to this directory.
    2.11  templates_path = ['_templates']