docs: update main index

Signed-off-by: perigoso <perigoso@riseup.net>
This commit is contained in:
perigoso 2021-07-27 19:47:05 +01:00
parent 37c56d677a
commit 358d781162
1 changed files with 19 additions and 14 deletions

View File

@ -1,20 +1,25 @@
.. TinyUSB documentation master file, created by
sphinx-quickstart on Mon Jul 26 17:17:52 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
:hide-toc:
*********
TinyUSB
*********
TinyUSB is an open-source cross-platform USB Host/Device stack for embedded systems,
designed to be memory-safe with no dynamic allocation and thread-safe with all interrupt events being deferred and then handled in the non-ISR task function.
Welcome to TinyUSB's documentation!
===================================
.. toctree::
:maxdepth: 2
:caption: Contents:
:caption: Index
:hidden:
Info <info/index>
Reference <reference/index>
Contributing <contributing/index>
.. toctree::
:caption: External Links
:hidden:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
Source Code <https://github.com/hathach/tinyusb>
Issue Tracker <https://github.com/hathach/tinyusb/issues>
Discussions <https://github.com/hathach/tinyusb/discussions>