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/index.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/index.rst')
| -rw-r--r-- | docs/source/index.rst | 73 |
1 files changed, 0 insertions, 73 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index d17c4db..0000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. _index: - -LeafLabs Documentation Index -============================ - -Welcome! This is the Maple documentation index. - -If you just bought a Maple board, you probably want to head to the -:ref:`quickstart <maple-quickstart>`. If you're having problems, -check out the :ref:`troubleshooting <troubleshooting>` page. - -Have fun! - -.. _index-usage: - -**Usage Guides:** - -.. toctree:: - :maxdepth: 1 - - Quickstart <maple-quickstart> - IDE Installation <maple-ide-install> - IDE Usage <ide> - Command-Line Toolchain <unix-toolchain> - -.. _index-maple-programming: - -**Maple Programming:** - -.. toctree:: - :maxdepth: 1 - - Language <language> - Libraries <libraries> - Arduino Compatibility <arduino-compatibility> - libmaple <libmaple> - Bootloader <bootloader> - Troubleshooting <troubleshooting> - Notes on GCC's ARM target <arm-gcc> - Complete Language Index <language-index> - -.. _index-hardware: - -**Hardware Peripherals:** - -.. toctree:: - :maxdepth: 1 - - adc - external-interrupts - gpio - i2c - jtag - pwm - spi - timers - systick - usb - usart - -.. _index-boards: - -**Board Hardware Documentation:** - -.. toctree:: - :maxdepth: 1 - - hardware/maple.rst - hardware/maple-ret6.rst - hardware/maple-mini.rst - -.. TODO write/include these upon Mini and Native release -.. hardware/maple-native.rst |