some comment stubs

7 files changed, 124 insertions, 7 deletions

diff --git a/docs/source/bootloader.rst b/docs/source/bootloader.rst
new file mode 100644
index 0000000..f893e1e
--- /dev/null
+++ b/docs/source/bootloader.rst
@@ -0,0 +1,5 @@
+==================
+ Maple Bootloader
+==================
+
+stub
diff --git a/docs/source/conf.py b/docs/source/conf.py
index c12ebb9..e9c55b2 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -45,7 +45,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'libmaple'
-copyright = u'2010, Marti Bolivar, Perry Hung, Andrew Meyer, Brian Newbold'
+copyright = u'2010, LeafLabs, LLC'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -184,7 +184,7 @@ htmlhelp_basename = 'libmapledoc'
 # (source start file, target file, title, author, documentclass [howto/manual])
 latex_documents = [
   ('index', 'libmaple.tex', u'libmaple Documentation',
-   u'Marti Bolivar, Perry Hung, Andrew Meyer, Brian Newbold', 'manual'),
+   u'LeafLabs, LLC', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -217,7 +217,7 @@ latex_documents = [
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'libmaple', u'libmaple Documentation',
-     [u'Marti Bolivar, Perry Hung, Andrew Meyer, Brian Newbold'], 1)
+     [u'LeafLabs, LLC'], 1)
 ]
 
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 0bf6b5a..92b2d5d 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -3,18 +3,29 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to libmaple's documentation!
-====================================
+Maple Documentation Index
+=========================
 
-Contents:
+Welcome!  This is the documentation index for programming your Maple.
+It contains technical documentation, as well as some getting started
+guides and example projects.
+
+.. TODO add projects
+
+Parts of the documentation:
 
 .. toctree::
    :maxdepth: 2
 
+   Language reference <language>
+   Library reference <libraries>
+   Unix toolchain <unix-toolchain>
+   libmaple (C library) API <libmaple>
+   Maple bootloader <bootloader>
+
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
 
diff --git a/docs/source/language.rst b/docs/source/language.rst
new file mode 100644
index 0000000..edc027d
--- /dev/null
+++ b/docs/source/language.rst
@@ -0,0 +1,86 @@
+.. _language:
+
+==========================
+ Maple Language Reference
+==========================
+
+The Maple can be programmed in a mostly-complete subset of the the
+`Wiring <http://www.wiring.org.co/reference/>`_ language, which is the
+same language used to program the `Arduino <http://arduino.cc/>`_
+boards.  The entire language will be supported in a future release.
+Please see the extensive `language reference
+<http://arduino.cc/en/Reference/HomePage>`_ on the Arduino webpage for
+more information, or follow a direct link below.
+
+Unique Maple Additions
+----------------------
+
+``ASSERT(...)``
+    The ``ASSERT()`` function can be very useful for basic program
+    debugging. The function accepts a boolean; for example:
+
+      ``ASSERT(state == WAIT);``
+
+    zero is false and any other number is true. If the boolean is true
+    the assertion passes and the program continues as usual. If it is
+    false, the assertion fails: the program is halted, debug
+    information is printed to USART2, and the status LED begins to
+    throb in intensity (it's noticeably different from blinking). The
+    debug information is printed at 9600 baud and consists of the
+    filename and line number where the particular assertion failed.
+
+    Including assertions in a program increases the program size. When
+    using libmaple from the command line, they can be silently
+    disabled by setting the ``DEBUG_LEVEL`` variable to ``DEBUG_NONE``
+    in `libmaple.h <>`; in this case all assertions pass without any
+    lost clock cycles.
+
+Arduino Documentation Links
+---------------------------
+
+.. .. list-table:: Frozen Delights!
+..    :widths: 15 10 30
+..    :header-rows: 1
+
+..    * - Treat
+..      - Quantity
+..      - Description
+..    * - Albatross
+..      - 2.99
+..      - On a stick!
+..    * - Crunchy Frog
+..      - 1.49
+..      - If we took the bones out, it wouldn't be
+..        crunchy, now would it?
+..    * - Gannet Ripple
+..      - 1.99
+..      - On a stick!
+
+.. =====  =====  =======
+.. A      B      A and B
+.. =====  =====  =======
+.. False  False  False
+.. True   False  False
+.. False  True   False
+.. True   True   True
+.. =====  =====  =======
+
+.. +------------------------+------------+----------+----------+
+.. | Header row, column 1   | Header 2   | Header 3 | Header 4 |
+.. | (header rows optional) |            |          |          |
+.. +========================+============+==========+==========+
+.. | body row 1, column 1   | column 2   | column 3 | column 4 |
+.. +------------------------+------------+----------+----------+
+.. | body row 2             | ...        | ...      |          |
+.. +------------------------+------------+----------+----------+
+
+Recommended Reading
+-------------------
+
+* `newlib Documentation <http://sourceware.org/newlib/>`_
+* STMicro documentation for STM32F103RB microcontroller:
+
+    * `All documents <http://www.st.com/mcu/devicedocs-STM32F103RB-110.html>`_
+    * `Datasheet (pdf) <http://www.st.com/stonline/products/literature/ds/13587.pdf>`_
+    * `Reference Manual (pdf) <http://www.st.com/stonline/products/literature/rm/13902.pdf>`_
+    * `Programming Manual (pdf) <http://www.st.com/stonline/products/literature/pm/15491.pdf>`_ (assembly language and register reference)
diff --git a/docs/source/libmaple.rst b/docs/source/libmaple.rst
new file mode 100644
index 0000000..c7e5c83
--- /dev/null
+++ b/docs/source/libmaple.rst
@@ -0,0 +1,5 @@
+====================
+ libmaple Reference
+====================
+
+Stub.
diff --git a/docs/source/libraries.rst b/docs/source/libraries.rst
new file mode 100644
index 0000000..0189e53
--- /dev/null
+++ b/docs/source/libraries.rst
@@ -0,0 +1,5 @@
+=========================
+ Maple Library Reference
+=========================
+
+Stub
diff --git a/docs/source/unix-toolchain.rst b/docs/source/unix-toolchain.rst
new file mode 100644
index 0000000..8f7ce7c
--- /dev/null
+++ b/docs/source/unix-toolchain.rst
@@ -0,0 +1,5 @@
+================
+ Unix Toolchain
+================
+
+Stub