Take the 2-minute tour ×
Super User is a question and answer site for computer enthusiasts and power users. It's 100% free, no registration required.

I'm writing and correcting API documentation in Sphinx using reStructuredText. Does anyone know of a good spellchecker that will handle this format, or a bunch of Unix/Linux tools that will allow me to use Aspell with it?

share|improve this question
add comment

2 Answers 2

up vote 1 down vote accepted

There's a Sphinx extension for spell checking. It uses enchant, rather than aspell, but perhaps you might find it useful.

https://bitbucket.org/dhellmann/sphinxcontrib-spelling

there's a blog article about it here:

http://doughellmann.com/2011/05/creating-a-spelling-checker-for-restructuredtext-documents-2.html

which explains how the extension was created, so if you're set on/stuck with using aspell specifically, maybe you can adapt it to aspell.

share|improve this answer
add comment

Since aspell has options for checking HTML and TeX files, you can spell-check some HTML or Tex produced by Sphinx. I imagine you could also use aspell on text output from Sphinx - assuming that removes any mark-up (e.g. asterisks) that might confuse aspell .

share|improve this answer
    
What would the command line be for checking a single file interactively? –  larsmans May 22 '11 at 17:18
    
aspell check [options] filename according to the manual –  RedGrittyBrick May 22 '11 at 17:19
    
I meant the Sphinx command. I can only find the command for building an entire directory full of files, rather than turning a single file into flat text. –  larsmans May 22 '11 at 18:29
add comment

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Not the answer you're looking for? Browse other questions tagged or ask your own question.