diff options
| author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-06-11 19:25:29 -0400 |
|---|---|---|
| committer | Marti Bolivar <mbolivar@leaflabs.com> | 2011-06-11 20:05:33 -0400 |
| commit | 0c2b3c667bf157dc2344e3dbc2aae0e11e37387b (patch) | |
| tree | 3008ee192c80f17f640ebdeb870442e78415ce6b /docs/source/spi.rst | |
| parent | d4b576fcadecf66b7b754af7d204bb6f3b4a9830 (diff) | |
| download | librambutan-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/spi.rst')
| -rw-r--r-- | docs/source/spi.rst | 30 |
1 files changed, 0 insertions, 30 deletions
diff --git a/docs/source/spi.rst b/docs/source/spi.rst deleted file mode 100644 index dd9f1f5..0000000 --- a/docs/source/spi.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _spi: - -===== - SPI -===== - -The Serial Peripheral Interface Bus (SPI) is a serial data transfer -protocol useful for interacting with a wide variety of hardware -peripherals. - -The public libmaple API for managing the SPI ports is the -:ref:`HardwareSPI <lang-hardwarespi>` class. - -Recommended Reading -------------------- - -* `Wikipedia Article on Serial Peripheral Interface Bus (SPI) - <http://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus>`_ - -* `Arduino reference on SPI - <http://www.arduino.cc/playground/Code/Spi>`_ - -* `Hardcore SPI on Arduino <http://klk64.com/arduino-spi/>`_ by kik64 - -* ST Documentation: - - * Reference Manual `RM0008 - <http://www.st.com/stonline/products/literature/rm/13902.pdf>`_ - (PDF), Chapter 25, "Serial Peripheral Interface" - |