Start working on documentation

julien-duponchelle · julien-duponchelle · commit fcc9037254d5 · 2013-04-28T21:49:21.000+02:00
diff --git a/docs/binlogstream.rst b/docs/binlogstream.rst
@@ -0,0 +1,7 @@
+###################
+BinLogStreamReader
+###################
+
+
+.. automodule:: pymysqlreplication.binlogstream
+    :members:
diff --git a/docs/events.rst b/docs/events.rst
@@ -0,0 +1,15 @@
+###################
+Events
+###################
+
+.. automodule:: pymysqlreplication.event
+    :members:
+
+==========
+Row events
+==========
+
+This events are send by MySQL when data are modified.
+
+.. automodule:: pymysqlreplication.row_event
+    :members:
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -0,0 +1,6 @@
+########
+Examples
+########
+
+You can found a list of working examples here: https://github.com/noplay/python-mysql-replication/tree/master/examples
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,18 +5,22 @@
 
 Welcome to Python MySQL Replication's documentation!
 ====================================================
+Pure Python Implementation of MySQL replication protocol build on top of PyMYSQL 
 
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+    :maxdepth: 2
 
+    binlogstream
+    events
+    examples
+    licence
 
-
-.. automodule:: pymysqlreplication.binlogstream
-    :members:
-
-.. automodule:: pymysqlreplication
+Contributing
+==============
+You can report issues and contribute to the project on:
+https://github.com/noplay/python-mysql-replication
 
 Indices and tables
 ==================
diff --git a/docs/licence.rst b/docs/licence.rst
@@ -0,0 +1,11 @@
+#######
+Licence
+#######
+
+Copyright 2012 Julien Duponchelle
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
