diff options
| author | perigoso <[email protected]> | 2021-07-27 19:47:05 +0100 |
|---|---|---|
| committer | perigoso <[email protected]> | 2021-07-30 12:46:30 +0100 |
| commit | 358d7811627ab70bacf6c28fbec4a6b5a3783463 (patch) | |
| tree | fbdefa5c977407cbc0559eb69fa5a2e0df58da05 /docs | |
| parent | 37c56d677a3cb01b3b89bafb3f53dacfb9264863 (diff) | |
docs: update main index
Signed-off-by: perigoso <[email protected]>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 33 |
1 files changed, 19 insertions, 14 deletions
diff --git a/docs/index.rst b/docs/index.rst index d30b743f4..2a032c51e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -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: -Welcome to TinyUSB's documentation! -=================================== +********* +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. -.. toctree:: - :maxdepth: 2 - :caption: Contents: +.. toctree:: + :caption: Index + :hidden: + Info <info/index> + Reference <reference/index> + Contributing <contributing/index> -Indices and tables -================== +.. toctree:: + :caption: External Links + :hidden: -* :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> |