open-tamil
open-tamil copied to clipboard
Add reST documentation for open-tamil classes/methods
Continue work started by @arulalant to add reST docs for open-tamil classes and methods.
Currently the following modules are exported to user as API via pip install.
- tamil
- transliterate
- ngram
- tamil.txt2ipa
- tamil.txt2unicode
- tamil.utils
- solthiruthi
- solthiruthi.stemmer
- spell
and the following command line tools,
- tamilwordcount.py
- tamilwordfilter.py
- tamilurlfilter.py
- tamilphonetic.py
- tamiltscii2utf8.py
- tamilwordgrid.py
As first effort : http://tamilpesu.us/apidoc/ will showcase the autogenerated sphinx docs via sphinx-apidoc command. The shell file 'build_sphinx.sh' is added via commit : 58114360659e81c151a994d9d2608c8e1813fb3c
Actually, more documentation needs to be added in source files. Commit 58114360659e81c151a994d9d2608c8e1813fb3c only provides a way to showcase our docs.