aboutsummaryrefslogtreecommitdiffstats
path: root/source/index.rst
diff options
context:
space:
mode:
authorMarti Bolivar <mbolivar@leaflabs.com>2011-10-08 00:27:46 -0400
committerMarti Bolivar <mbolivar@leaflabs.com>2011-10-08 00:32:02 -0400
commitf780ea927c32cf0fc72ab0e3f3fda1d4df644b29 (patch)
treed96f8b1e964865ac35d6dd9fc2562b8b3210186b /source/index.rst
parent0b5fd1df1a87f240b9a93c4f46983ebcb9d71242 (diff)
downloadlibrambutan-f780ea927c32cf0fc72ab0e3f3fda1d4df644b29.tar.gz
librambutan-f780ea927c32cf0fc72ab0e3f3fda1d4df644b29.zip
Redo appearance of top-level docs and pages.
This is a fairly significant set of changes, aimed at improving the overall usability of the documentation. Add source/_templates/indexcontent.html, which is a Jinja template used to generate index.html. This mimics the Python docs' style of having a short, styled table as main index interface. We're doing this because people keep missing the board hardware pages that are below the fold. Hopefully this will make them (and other important pages) easier to find. The new file source/_static/index-style.css controls the presentation of the generated index.html. Move the contents of source/index.rst to source/contents.rst, and increase the toctree depths to 2. This increase has the ancillary benefit that secondary headers within the current page are displayed in the sidebar, which should aid navigation within the page. contents.rst is meant to be a contents in full, where users who know what they're looking for can go. The "Table of Contents" link on the sidebar points here. Add a new source/_static/leaflabs-docs.css. It's currently unused, but is the place where people should put CSS that wants to override the defaults. Modify source/_templates/layout.html to include aforementioned leaflabs-docs.css. Also tweak the behavior of the rootrellink block, which provides the breadcrumbs in page headers and footers. Change the titles of various top-level docs so they can be referenced from the toctrees in contents.rst directly. Having two names (one in the contents, one at the top of the page) has got to be confusing people. Make an exception for FAQ so that it appears in one line on the sidebar. Adjust conf.py to reflect all of these changes. Also: - Fix "Lucidia" -> "Lucida" typo - Get rid of intersphinx_mapping (we don't use it, and including it makes it impossible to build the docs offline). - Remove the logo from sidebar; it's big and ugly and serves no purpose. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'source/index.rst')
-rw-r--r--source/index.rst78
1 files changed, 0 insertions, 78 deletions
diff --git a/source/index.rst b/source/index.rst
deleted file mode 100644
index e8f0277..0000000
--- a/source/index.rst
+++ /dev/null
@@ -1,78 +0,0 @@
-.. _index:
-
-LeafLabs Documentation Index
-============================
-
-Welcome to the LeafLabs documentation!
-
-If you're setting up a board for the first time, try the
-:ref:`quickstart <maple-quickstart>`. If you're having problems,
-check out the :ref:`troubleshooting <troubleshooting>` and :ref:`FAQ
-<faq>` pages.
-
-If you can't find what you're looking for here, try the `LeafLabs wiki
-<http://wiki.leaflabs.com/index.php?title=Main_Page>`_.
-
-.. _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
- Bootloader <bootloader>
- Troubleshooting <troubleshooting>
- FAQ <faq>
- GCC and libc for Maple <arm-gcc>
- Language Index <language-index>
-
-.. _index-hardware:
-
-**Hardware Peripherals:**
-
-.. toctree::
- :maxdepth: 1
-
- adc
- external-interrupts
- fsmc
- 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
- hardware/maple-native-beta.rst
-
-.. TODO [Maple Native] write/include upon finished Native release
-.. hardware/maple-native.rst