Hello.
Sometime ago, I wrote module, that checks all documentation strings
and comments for spelling errors. Now, I use Sphinx for documentation
and pydsc integrates nicely with it.
The following is cut-and-paste of code from my conf.py file:
try:
import pydsc
#report errors related to the project only
pydsc.include_paths( project_root )
pydsc.ignore_dictionary( 'ignore_dictionary.txt' )
pydsc.set_text_preprocessor( pydsc.sphinx_preprocessor )
import pygccxml
import pyplusplus
except:
pass #it is possible that pyenchant is not installed
Every module imported after pydsc will be checked for errors. The
documentation and other examples you can find here:
http://language-binding.net/pydsc/pydsc.html
pydsc has one advantage over other spell checkers. It tries to exclude
code examples and identifiers from being checked, which decrease the
number of errors from spell checker. So you actually see real errors,
almost without noise.
I use pydsc for both my projects and it works fine for me. May be you
will find it useful for you too.
Your comments are welcome.
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups
"sphinx-dev" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to
[email protected]
For more options, visit this group at
http://groups.google.com/group/sphinx-dev?hl=en
-~----------~----~----~----~------~----~------~--~---
