From 29f226c2fb09baa9b618a5bb7f390ff51882ae32 Mon Sep 17 00:00:00 2001 From: hathach Date: Fri, 27 Dec 2024 11:39:33 +0700 Subject: [PATCH] docs index.rst pointed to README.rst --- README.rst | 27 +++------------------------ docs/index.rst | 8 +------- 2 files changed, 4 insertions(+), 31 deletions(-) diff --git a/README.rst b/README.rst index eb024968e8..d2141958f7 100644 --- a/README.rst +++ b/README.rst @@ -5,14 +5,14 @@ Sponsors TinyUSB is funded by: Adafruit. Purchasing products from them helps to support this project. -.. figure:: docs/assets/adafruit_logo.svg +.. figure:: /docs/assets/adafruit_logo.svg :alt: Adafruit Logo :target: https://www.adafruit.com TinyUSB Project =============== -.. figure:: docs/assets/logo.svg +.. figure:: /docs/assets/logo.svg :alt: TinyUSB TinyUSB is an open-source cross-platform USB Host/Device stack for @@ -20,7 +20,7 @@ embedded system, designed to be memory-safe with no dynamic allocation and thread-safe with all interrupt events are deferred then handled in the non-ISR task function. Check out the online `documentation `__ for more details. -.. figure:: docs/assets/stack.svg +.. figure:: /docs/assets/stack.svg :width: 500px :alt: stackup @@ -250,27 +250,6 @@ individually licensed especially those in ``lib`` and ``hw/mcu`` folder. Please make sure you understand all the license term for files you use in your project. -Docs -==== - -- Info - - - `Uses`_ - - `Changelog`_ - - `Contributors`_ - -- `Reference`_ - - - `Getting Started`_ - - `Supported Boards`_ - - `Dependencies`_ - - `Concurrency`_ - -- `Contributing`_ - - - `Code of Conduct`_ - - `Structure`_ - - `Porting`_ .. |Build Status| image:: https://github.com/hathach/tinyusb/actions/workflows/build.yml/badge.svg :target: https://github.com/hathach/tinyusb/actions diff --git a/docs/index.rst b/docs/index.rst index 2a032c51ec..0f8011e91b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,12 +1,6 @@ :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. - +.. include:: ../README.rst .. toctree:: :caption: Index