.. indictrans documentation master file, created by
   sphinx-quickstart on Thu Jul 14 18:45:00 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to indictrans's documentation!
======================================

The project aims on adding a state-of-the-art transliteration module for cross transliterations among all Indian languages including English and Urdu.

|travis| |coverage| |CircleCI|

----

The module currently supports the following languages:

  * Hindi
  * Bengali
  * Gujarati
  * Punjabi
  * Malayalam
  * Kannada
  * Tamil
  * Telugu
  * Oriya
  * Marathi
  * Assamese
  * Konkani
  * Bodo
  * Nepali
  * Urdu
  * English


Module Reference
----------------

.. toctree::
    :maxdepth: 2

    module_trans


User Guide
----------

.. toctree::
   :maxdepth: 2

   guide_installation
   guide_model
   guide_transliteration.rst


Indices and tables
------------------

* :ref:`genindex`
* :ref:`search`


----

|travis| |coverage| |CircleCI|

.. |travis| image:: https://travis-ci.org/libindic/indic-trans.svg?branch=master
   :target: https://travis-ci.org/libindic/indic-trans
   :alt: travis-ci build status

.. |coverage| image:: https://coveralls.io/repos/github/libindic/indic-trans/badge.svg?branch=master 
   :target: https://coveralls.io/github/libindic/indic-trans?branch=master
   :alt: coveralls.io coverage status
   
.. |CircleCI| image:: https://circleci.com/gh/libindic/indic-trans.svg?style=svg
    :target: https://circleci.com/gh/libindic/indic-trans