summaryrefslogtreecommitdiff
path: root/tox.ini
diff options
context:
space:
mode:
authorWaylan Limberg <waylan.limberg@icloud.com>2015-02-07 14:28:42 -0500
committerWaylan Limberg <waylan.limberg@icloud.com>2015-02-07 14:28:42 -0500
commit32df5ad916626b0ddd6f0d980f350c6485f23867 (patch)
tree0f5539243138abd0a77bda9a234885c45836ad04 /tox.ini
parent93dad08ca9967d75e5bb2b2e6e6301a98b900bfd (diff)
downloadpython-markdown-32df5ad916626b0ddd6f0d980f350c6485f23867.tar.gz
Add Docs spellchecking Test.
Not sure this is the best way to go, but it works. I'm not crazy about running the spellcheck against the built docs, but aspell has a builtin option to easily ignore everything in `<code>` tags which greatly simplfies things. I looked at Doug Hellmans' sphinxcontrib-spelling package which does something similar for Sphinx. However, as Sphinx uses rST and the rST parser outputs a parse tree, Doug is essentially taking that parse tree and running the spellcheck on the appropriate parts (skipping code, etc.). He did a nice [writeup][5] of his development process if you are interested. As Python-Markdown's parse tree is represented as HTML (through ElementTree) I would have to use HTML anyway. And [PyEnchant][2] doesn't currently have good support for HTML. So I used [aspell][3], with inspiration from the [git-spell-check][4] hook. [1]: http://sphinxcontrib-spelling.readthedocs.org/en/latest/index.html [2]: https://pythonhosted.org/pyenchant/ [3]: http://aspell.net/ [4]: https://github.com/mprpic/git-spell-check [5]: http://doughellmann.com/2011/05/26/creating-a-spelling-checker-for-restructuredtext-documents.html
Diffstat (limited to 'tox.ini')
-rw-r--r--tox.ini6
1 files changed, 5 insertions, 1 deletions
diff --git a/tox.ini b/tox.ini
index 9d62ff2..c4384a2 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,5 +1,5 @@
[tox]
-envlist = py27, py32, py33, py34, pypy, flake8
+envlist = py27, py32, py33, py34, pypy, flake8, checkspelling
[testenv]
downloadcache = {toxworkdir}/cache
@@ -11,5 +11,9 @@ commands = coverage run --source=markdown {toxinidir}/run-tests.py {posargs}
deps = flake8
commands = flake8 {toxinidir}/markdown {toxinidir}/tests {toxinidir}/setup.py {toxinidir}/run-tests.py
+[testenv:checkspelling]
+deps =
+commands = {toxinidir}/checkspelling.sh
+
[flake8]
max-line-length = 119 \ No newline at end of file