diff options
| author | rfkelly0 <rfkelly0@67cdc799-7952-0410-af00-57a81ceafa0f> | 2010-12-30 22:21:35 +0000 |
|---|---|---|
| committer | rfkelly0 <rfkelly0@67cdc799-7952-0410-af00-57a81ceafa0f> | 2010-12-30 22:21:35 +0000 |
| commit | e800c67e91eb9311c09988f5c9578e6dd075008e (patch) | |
| tree | 9bad60ce9531a71dca644f2e1862415f4ccb2ee5 /docs | |
| parent | 757b27dc229c333127a7bd363a4be3ce99864f2f (diff) | |
| download | pyfilesystem-e800c67e91eb9311c09988f5c9578e6dd075008e.tar.gz | |
add optional spellchecking support to docs makefile
git-svn-id: http://pyfilesystem.googlecode.com/svn/trunk@592 67cdc799-7952-0410-af00-57a81ceafa0f
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/Makefile | 5 | ||||
| -rw-r--r-- | docs/conf.py | 8 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 0 |
3 files changed, 13 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile index 6437bf5..67988fc 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -87,3 +87,8 @@ doctest: $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest @echo "Testing of doctests in the sources finished, look at the " \ "results in $(BUILDDIR)/doctest/output.txt." + +spelling: + $(SPHINXBUILD) -b spelling $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Spell checking of docs is finished.the" + diff --git a/docs/conf.py b/docs/conf.py index 6526577..6100996 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,6 +24,14 @@ import sys, os # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage'] +try: + import sphinxcontrib.spelling +except ImportError: + pass +else: + extensions.append("sphinxcontrib.spelling") + + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/spelling_wordlist.txt |