waylan / Python-Markdown / 156 / 3

Ran 07 Feb 2015 07:41PM UTC

Files 29

Run time 5s

Badge

Embed ▾

Committed 07 Feb 2015 07:28PM UTC coverage: 92.783%. First build

Job # TOXENV=py33

Build Type

push

travis-ci

Committed by

waylan

Commit Message

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

Run Details

2507 of 2702 relevant lines covered (92.78%)

0.93 hits per line

waylan / Python-Markdown / 156 / 3

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 156.3 (TOXENV=py33)

waylan / Python-Markdown / 156 / 3

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 156.3 (TOXENV=py33)

README BADGES
x