aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/libraries.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 19:25:29 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-06-11 20:05:33 -0400
commit0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch)
tree3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/libraries.rst
parentd4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff)
downloadlibrambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.tar.gz
librambutan-0c2b3c667bf157dc2344e3dbc2aae0e11e37387b.zip
Remove reST documentation, attendant updates.
The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation
Diffstat (limited to 'docs/source/libraries.rst')
-rw-r--r--docs/source/libraries.rst80
1 files changed, 0 insertions, 80 deletions
diff --git a/docs/source/libraries.rst b/docs/source/libraries.rst
deleted file mode 100644
index 44a72f7..0000000
--- a/docs/source/libraries.rst
+++ /dev/null
@@ -1,80 +0,0 @@
-.. highlight:: c++
-.. default-domain:: cpp
-
-.. _libraries:
-
-=========================
- Maple Library Reference
-=========================
-
-.. Note: if you port an Arduino library and document it here, be sure
-.. to update compatibility.rst to reflect that fact.
-
-This page lists the extra libraries that are part of the :ref:`Maple
-IDE <ide>` (along with the rest of :ref:`libmaple <libmaple>`). You
-can use a library from within a sketch by going to Sketch > Import
-Library... from within the IDE, then choosing the library you want.
-
-Any incompatibilities between the Maple and Arduino versions of a
-library are noted in the library's documentation.
-
-.. contents:: Contents
- :local:
-
-.. toctree::
- :hidden:
-
- libs/servo.rst
- libs/wire.rst
-
-.. admonition:: **Looking for Something Else?**
-
- - See the :ref:`language` for information on the core functions
- used for programming a Maple board.
-
- - If you're looking for something from the C standard library (like
- ``atoi()``, for instance): the :ref:`CodeSourcery GCC compiler
- <arm-gcc>` used to compile your programs is configured to link
- against `newlib <http://sourceware.org/newlib/>`_, and allows the
- use of any of its header files. However, dynamic memory allocation
- (``malloc()``, etc.) is not available.
-
- - If you're looking for low-level hardware support libraries, see
- the :ref:`libmaple Reference <libmaple>`.
-
-.. _libraries-servo:
-
-Servo
------
-
-The :ref:`Servo <libs-servo>` library is provided for convenient
-control of RC servomotors.
-
-.. _libraries-liquid-crystal:
-
-LiquidCrystal
--------------
-
-.. TODO [0.1.0] LiquidCrystal docs under libs/liquidcrystal.rst
-
-The LiquidCrystal library allows Maple to control LCD screens. For
-more information, see the `Arduino LiquidCrystal documentation
-<http://www.arduino.cc/en/Reference/LiquidCrystal>`_.
-
-**Arduino Compatibility**
-
-At this time, no incompatibilities between the Maple and Arduino
-versions are known (although the Maple version should perform
-significantly faster). Any observed differences should be considered
-bugs, and reported on the forums.
-
-.. _libraries-wire:
-
-Wire
-----
-
-.. FIXME [0.1.0] Update with hard Wire implementation info
-
-We currently provide a soft (bit-banged) implementation of the
-:ref:`Wire <libs-wire>` I2C library. A hardware version is planned
-for Maple IDE release 0.1.0.