.. sphinxcontrib-osaka documentation master file, created by
   sphinx-quickstart on Sat Apr 10 11:39:05 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===============================================
Welcome to sphinxcontrib-osaka's documentation!
===============================================

This module converts standard Japanese sentence into Osaka dialect.
Osaka is one of the most powerful area in Japan. So your formal Japanese sentence will become lively one.

Enjoy!

This module is tested only Python 2.6.

How to Use Sphinx Extension
===========================

At first, install sphinxcontrib.osaka package. Run following command under root/admin right.

.. code-block:: bash

   $ easy_install sphinxcontrib-osaka

Append 'sphinxcontrib.osaka' to extensions parameter, and run Sphinx.
There is no configuration parameter.

.. code-block:: python

   extensions = ['sphinxcontrib.osaka']

Standalone Function
===================

.. module:: sphinxcontrib.osaka

.. function:: convert(src)
   
   This module converts standard Japanese into Osaka diagram.
   
   :param src: input string(standard Japanese)
   :type  src: unicode
   :return: converted string
   :rtype: unicode

Licnece
=======

MIT/X

Author
======

Shibukawa Yoshiki(yoshiki at shibu.jp)

Repository
==========

* http://bitbucket.org/birkenfeld/sphinx-contrib/
