From 32df5ad916626b0ddd6f0d980f350c6485f23867 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Sat, 7 Feb 2015 14:28:42 -0500 Subject: 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 `` 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 --- .spell-dict | 118 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 118 insertions(+) create mode 100644 .spell-dict (limited to '.spell-dict') diff --git a/.spell-dict b/.spell-dict new file mode 100644 index 0000000..148c7dd --- /dev/null +++ b/.spell-dict @@ -0,0 +1,118 @@ +Abrahamsen +Altmayer +API +Artem +Babelmark +backtick +backticks +Balogh +BlockParser +Blockprocessor +Blockprocessors +blockquote +blockquotes +CamelCase +Chodarev +CLI +CodeHilite +Cogumbreiro +CSS +Dmitry +ElementTree +extendMarkdown +Fauske +Formatter +Fortin +GitHub +Gruber +GSoC +hacky +HeaderId +HTTPS +implementers +InlineProcessor +Jiryu +JSON +Kjell +Krech +kwargs +Limberg +Magne +MAILTO +makeExtension +Manfed +markdownFromFile +Maruku +multi +MultiMarkdown +munge +namespace +NanoDOM +Neale +nosetests +OrderedDict +OrderedDicts +OSX +Ph +PHP +Postprocessor +Postprocessors +Preprocessor +Preprocessors +Pygments +PyPI +PyPy +PYTHONPATH +PyTidyLib +PyYAML +rc +refactor +refactored +refactors +registerExtension +RSS +rST +ryneeverett +sanitizer +sanitizers +Sauder +schemeless +Sergej +serializer +serializers +Shachnev +slugify +SmartyPants +Sourceforge +StackOverflow +Stansifer +stdout +Stelios +Stienstra +subclasses +svn +Swartz +Szakmeister +Takteyev +Tiago +tokenized +tox +Trac +traceback +Tredinnick +Treeprocessor +Treeprocessors +tuples +unordered +untrusted +UTF +uTidylib +versa +Waylan +WikiLink +WikiLinks +Wolever +Xanthakis +XHTML +YAML +Yunusov -- cgit v1.2.3