add explaination about android module

tito · tito · commit 6a72910355bf · 2012-01-14T14:10:08.000+01:00
diff --git a/docs/source/android.rst b/docs/source/android.rst
@@ -0,0 +1,38 @@
+Android Python module
+=====================
+
+Python for android project include a python module named "android". This module is designed to give you an access to the Android API. As for today, the module is very limited, and waiting for contribution to wrap more Android API.
+
+Example
+-------
+
+::
+
+    import android
+
+    # activate the vibrator
+    android.vibrate(1)
+
+    # read screen dpi
+    print android.get_dpi()
+
+How it's working
+----------------
+
+The whole Android API is accessible in Java. Their is no native or extensible way to access it from Python. The schema for accessing to their API is:
+
+    [1] Cython -> [2] C JNI -> [3] Java
+
+#. The ``android.pyx`` is written in Cython: a language with typed informations, very close to Python, that generate Python extension. It's easier to write in Cython than CPython, and it's linked directly to the part 2.
+#. The second part define simple c methods that access to Java interfaces through JNI in the file ``android_jni.c``.
+#. The last part contain the Java code that will be called from the JNI stuff.
+
+All the source code is available at:
+
+    https://github.com/kivy/python-for-android/tree/master/recipes/android/src
+
+
+API
+---
+
+TODO
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -23,6 +23,7 @@ your application.
     howitworks.rst
     customize.rst
     recipes.rst
+    android.rst
     related.rst
 
 Indices and tables
