{# This file generates the top-level index.html file. We are very
   obviously stealing from the Python docs' style ;).
#}

<!-- Extend our layout.html. So inheritance hierarchy is Sphinx's
     layout, then our layout.html, then this file. -->
{% extends "layout.html" %}

<!-- Pull in extra index stylesheet -->
{% set css_files = css_files + ["_static/index-style.css"] %}

<!-- Separator for contents lists -->
{% set content_sep = "&middot;" %}

<!-- Content -->
{% block body %}
<h1>Hi There!</h1>

This is the documentation for librambutan, a libre firmware library for STM32
ARM microcontrollers. If browsing on the docs.rambutan.cc website, you can
select the version/branch from the box in the lower right-hand corner.

<h2>Read This First</h2>

Having problems? Check
out <a href="{{ pathto("troubleshooting") }}">Troubleshooting</a> and
the <a href="{{ pathto("faq") }}">FAQ</a>. Can't find what you want
here?  Head back up to the <a href="https://docs.rambutan.cc/">project-wide
docs</a>.
</p>

<p>See the <a href="{{ pathto("whats-new") }}">What's New</a> page for
changes that are new in '{{ release }}'.</p>

<h2>Contents at a Glance</h2>

<table class="contents-table">
  <tr>
    <td><p>Getting Started</p>
      <ul>
        <li><a href="{{ pathto("unix-toolchain") }}">Command-Line
                Toolchain</a></li>
      </ul>
    </td>
  </tr>
  <tr>
    <td><p>Programming</p>
      <ul>
        <li><a href="{{ pathto("language") }}">Language Reference</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("troubleshooting") }}">Troubleshooting</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("faq") }}">FAQ</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("libraries") }}">Libraries</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("libmaple") }}"><tt>libmaple</tt></a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("bootloader") }}">Bootloader</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("arm-gcc") }}">GCC and libc</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("arduino-compatibility") }}">Arduino
                Compatibility</a></li>
      </ul>
    </td>
    <td><p>Hardware and Peripherals</p>
      <ul>
        <li><a href="{{ pathto("stm32") }}">STM32</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("adc") }}">ADC</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("external-interrupts") }}">External
            Interrupts</a> {{ content_sep }}</li>
        <li><a href="{{ pathto("fsmc") }}">FSMC</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("gpio") }}">GPIO</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("i2c") }}">I<sup>2</sup>C</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("jtag") }}">JTAG</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("pwm") }}">PWM</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("spi") }}">SPI</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("systick") }}">SysTick</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("timers") }}">Timers</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("usart") }}">USART</a>
            {{ content_sep }}</li>
        <li><a href="{{ pathto("usb") }}">USB</a></li>
      </ul>
    </td>
  </tr>
</table>

{% endblock %}