From 136b5f5c20a82c02f06ce2fc1ee01a1fc7cfce98 Mon Sep 17 00:00:00 2001
From: Merlijn Wajer <merlijn@wajer.org>
Date: Sun, 13 Jun 2010 02:11:01 +0200
Subject: [PATCH] Autodoc for PyMML + WhySimba.

---
 Doc/sphinx/conf.py         |  4 +++-
 Doc/sphinx/index.rst       |  1 +
 Doc/sphinx/pymml.rst       | 11 +++++++++++
 Doc/sphinx/pymml/color.rst |  8 ++++++++
 Doc/sphinx/pymml/mouse.rst |  8 ++++++++
 Doc/sphinx/whysimba.rst    | 32 ++++++++++++++++++++++++++++++++
 6 files changed, 63 insertions(+), 1 deletion(-)
 create mode 100644 Doc/sphinx/pymml.rst
 create mode 100644 Doc/sphinx/pymml/color.rst
 create mode 100644 Doc/sphinx/pymml/mouse.rst

diff --git a/Doc/sphinx/conf.py b/Doc/sphinx/conf.py
index 731f7b1..367a269 100644
--- a/Doc/sphinx/conf.py
+++ b/Doc/sphinx/conf.py
@@ -18,11 +18,13 @@ import sys, os
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #sys.path.append(os.path.abspath('.'))
 
+sys.path.append(os.path.abspath('../../Projects/MMLLib/pymml'))
+
 # -- General configuration -----------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
+extensions = ['sphinx.ext.autodoc']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
diff --git a/Doc/sphinx/index.rst b/Doc/sphinx/index.rst
index ba42c78..cf49dda 100644
--- a/Doc/sphinx/index.rst
+++ b/Doc/sphinx/index.rst
@@ -22,6 +22,7 @@ Contents:
     reference.rst
     scriptreference.rst
     docdoc.rst
+    pymml.rst
 
 
 Indices and tables
diff --git a/Doc/sphinx/pymml.rst b/Doc/sphinx/pymml.rst
new file mode 100644
index 0000000..63838f9
--- /dev/null
+++ b/Doc/sphinx/pymml.rst
@@ -0,0 +1,11 @@
+.. _py-mml:
+
+Python MML
+==========
+
+.. toctree::
+    :maxdepth: 2
+
+    pymml/mouse.rst
+    pymml/color.rst
+
diff --git a/Doc/sphinx/pymml/color.rst b/Doc/sphinx/pymml/color.rst
new file mode 100644
index 0000000..af2efaf
--- /dev/null
+++ b/Doc/sphinx/pymml/color.rst
@@ -0,0 +1,8 @@
+PyMML Color
+===========
+
+This is the PyMML color class.
+
+.. automodule:: mmlcolor
+    :members:
+
diff --git a/Doc/sphinx/pymml/mouse.rst b/Doc/sphinx/pymml/mouse.rst
new file mode 100644
index 0000000..d5e42e8
--- /dev/null
+++ b/Doc/sphinx/pymml/mouse.rst
@@ -0,0 +1,8 @@
+PyMML Mouse
+===========
+
+This is the PyMML mouse class.
+
+.. automodule:: mmlmouse
+    :members:
+
diff --git a/Doc/sphinx/whysimba.rst b/Doc/sphinx/whysimba.rst
index f190ea1..2c72f44 100644
--- a/Doc/sphinx/whysimba.rst
+++ b/Doc/sphinx/whysimba.rst
@@ -2,3 +2,35 @@ Why Simba?
 ==========
 
 GEWOON MAN
+
+    *
+
+      Programmable
+      In fact, the only way to use it, is to write a program that Simba will execute.
+    *
+
+      Extensible
+      Simba supports both plugins in machine code as well as extensions written in the Simba programming language. (Pascal)
+    *
+
+      Free (As in Free Beer and as in Freedom)
+
+      Simba is 100% free to use. In fact, we welcome you to share it with the rest of the world.
+
+      The source code to the program is also freely available, under the GPL license.
+    *
+
+      Reliable
+      Simba is actively maintained by a team of knowledgable programmers. We as a team do our best to make Simba into a quality product. However: this does not guarantee a bug free program. (Bug free programs don't exist)
+    *
+
+      Cross Platform
+
+      Simba has been written with freedom in mind and believes Simba should not be limited to one platform, as that limits its users to one platform as well. Currently the supported platforms are Windows and Linux.
+
+      Even though we try hard to make Simba bug-free on all platforms, some issues remain. The biggest issue is the component that executes your program. It is an external component and does not play too well on Linux. Hopefully we will be able to fix this soon.
+    *
+
+      Quite fast
+      The Simba developers have designed and written Simba with speed in mind. However, focussing too much on speed is in reality not a good case. It often leads to instability and more bugs in the program. For Simba, we have sacraficed some speed to make a more featureful and stable program.
+