From e800c67e91eb9311c09988f5c9578e6dd075008e Mon Sep 17 00:00:00 2001
From: rfkelly0 <rfkelly0@67cdc799-7952-0410-af00-57a81ceafa0f>
Date: Thu, 30 Dec 2010 22:21:35 +0000
Subject: add optional spellchecking support to docs makefile

git-svn-id: http://pyfilesystem.googlecode.com/svn/trunk@592 67cdc799-7952-0410-af00-57a81ceafa0f
---
 docs/Makefile              | 5 +++++
 docs/conf.py               | 8 ++++++++
 docs/spelling_wordlist.txt | 0
 3 files changed, 13 insertions(+)
 create mode 100644 docs/spelling_wordlist.txt

(limited to 'docs')

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
-- 
cgit v1.2.1