Merge pull request #3278 from c1570/improved_docs

Documentation improvements

Author: hathach

.github/workflows/static_analysis.yml

@@ -90,7 +90,8 @@ jobs:
           path: ${{ steps.analyze.outputs.sarif-output }}
 
   PVS-Studio:
-    if: github.repository_owner == 'hathach'
+    # Only run on non-forked PR since secrets token is required
+    if: github.repository_owner == 'hathach' && github.event.pull_request.head.repo.fork == false
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
@@ -141,7 +142,8 @@ jobs:
           path: pvs-studio-${{ matrix.board }}.sarif
 
   SonarQube:
-    if: github.repository_owner == 'hathach'
+    # Only run on non-forked PR since secrets token is required
+    if: github.repository_owner == 'hathach' && github.event.pull_request.head.repo.fork == false
     runs-on: ubuntu-latest
     env:
       BUILD_WRAPPER_OUT_DIR: build_wrapper_output_directory
@@ -184,7 +186,8 @@ jobs:
             --define sonar.cfamily.compile-commands=${{ env.BUILD_WRAPPER_OUT_DIR }}/compile_commands.json
 
   IAR-CStat:
-    #if: github.repository_owner == 'hathach'
+    # Only run on non-forked PR since secrets token is required
+    #if: github.repository_owner == 'hathach' && github.event.pull_request.head.repo.fork == false
     if: false
     runs-on: ubuntu-latest
     strategy:

README.rst

@@ -1,26 +1,55 @@
+TinyUSB
+=======
+
 |Build Status| |CircleCI Status| |Documentation Status| |Static Analysis| |Fuzzing Status| |License|
 
 Sponsors
-========
+--------
 
 TinyUSB is funded by: Adafruit. Purchasing products from them helps to support this project.
 
 .. figure:: docs/assets/adafruit_logo.svg
    :alt: Adafruit Logo
+   :align: left
    :target: https://www.adafruit.com
 
-TinyUSB Project
-===============
+.. raw:: html
+
+   <div class="clear-both"></div>
+
+Overview
+--------
 
 .. figure:: docs/assets/logo.svg
    :alt: TinyUSB
+   :align: left
+
+.. raw:: html
+
+   <div class="clear-both"></div>
+
+TinyUSB is an open-source cross-platform USB Host/Device stack for embedded systems. It’s designed for memory safety
+(no dynamic allocation) and thread safety (all interrupts deferred to non-ISR task functions). The stack emphasizes portability,
+small footprint, and real-time performance across 50+ MCU families.
 
-TinyUSB is an open-source cross-platform USB Host/Device stack for 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 <https://docs.tinyusb.org/>`__ for more details.
+Key Features
+------------
+
+* **Thread-safe:** USB interrupts deferred to task context
+* **Memory-safe:** No dynamic allocation, all buffers static
+* **Portable:** Supports 50+ MCU families
+* **Comprehensive:** Includes CDC, HID, MSC, Audio, and Host support
+* **RTOS-friendly:** Works with bare metal, FreeRTOS, RT-Thread, and Mynewt
 
 .. figure:: docs/assets/stack.svg
    :width: 500px
+   :align: left
    :alt: stackup
 
+.. raw:: html
+
+   <div class="clear-both"></div>
+
 ::
 
     .
@@ -36,7 +65,7 @@ TinyUSB is an open-source cross-platform USB Host/Device stack for embedded syst
 
 
 Getting started
-===============
+---------------
 
 See the `online documentation <https://docs.tinyusb.org>`_ for information about using TinyUSB and how it is implemented.
 
@@ -49,7 +78,7 @@ For bugs and feature requests, please `raise an issue <https://github.com/hathac
 See `Porting`_ guide for adding support for new MCUs and boards.
 
 Device Stack
-============
+------------
 
 Supports multiple device configurations by dynamically changing USB descriptors, low power functions such like suspend, resume, and remote wakeup. The following device classes are supported:
 
@@ -70,7 +99,7 @@ Supports multiple device configurations by dynamically changing USB descriptors,
 If you have a special requirement, ``usbd_app_driver_get_cb()`` can be used to write your own class driver without modifying the stack. Here is how the RPi team added their reset interface `raspberrypi/pico-sdk#197 <https://github.com/raspberrypi/pico-sdk/pull/197>`_
 
 Host Stack
-==========
+----------
 
 - Human Interface Device (HID): Keyboard, Mouse, Generic
 - Mass Storage Class (MSC)
@@ -81,14 +110,14 @@ Host Stack
 Similar to the Device Stack, if you have a special requirement, ``usbh_app_driver_get_cb()`` can be used to write your own class driver without modifying the stack.
 
 Power Delivery Stack
-====================
+--------------------
 
 - Power Delivery 3.0 (PD3.0) with USB Type-C support (WIP)
 - Super early stage, only for testing purpose
 - Only support STM32 G4
 
 OS Abstraction layer
-====================
+--------------------
 
 TinyUSB is completely thread-safe by pushing all Interrupt Service Request (ISR) events into a central queue, then processing them later in the non-ISR context task function. It also uses semaphore/mutex to access shared resources such as Communication Device Class (CDC) FIFO. Therefore the stack needs to use some of the OS's basic APIs. Following OSes are already supported out of the box.
 
@@ -98,7 +127,7 @@ TinyUSB is completely thread-safe by pushing all Interrupt Service Request (ISR)
 - **Mynewt** Due to the newt package build system, Mynewt examples are better to be on its `own repo <https://github.com/hathach/mynewt-tinyusb-example>`_
 
 Supported CPUs
-==============
+--------------
 
 +--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
 | Manufacturer | Family                      | Device | Host | Highspeed | Driver                 | Note              |
@@ -234,7 +263,7 @@ Supported CPUs
 +--------------+-----------------------------+--------+------+-----------+------------------------+-------------------+
 
 Table Legend
-------------
+^^^^^^^^^^^^
 
 ========= =========================
 ✔         Supported
@@ -244,7 +273,7 @@ Table Legend
 ========= =========================
 
 Development Tools
-=================
+-----------------
 
 The following tools are provided freely to support the development of the TinyUSB project:
 
@@ -273,6 +302,5 @@ The following tools are provided freely to support the development of the TinyUS
 .. _Supported Boards: docs/reference/boards.rst
 .. _Dependencies: docs/reference/dependencies.rst
 .. _Concurrency: docs/reference/concurrency.rst
-.. _Contributing: docs/contributing/index.rst
 .. _Code of Conduct: CODE_OF_CONDUCT.rst
-.. _Porting: docs/contributing/porting.rst
+.. _Porting: docs/porting.rst

docs/_static/custom.css

@@ -0,0 +1,3 @@
+.clear-both {
+  clear: both;
+}

docs/conf.py

@@ -14,7 +14,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'TinyUSB'
-copyright = '2024, Ha Thach'
+copyright = '2025, Ha Thach'
 author = 'Ha Thach'
 
 
@@ -41,6 +41,8 @@
 html_theme_options = {
     'sidebar_hide_name': True,
 }
+html_static_path = ['_static']
+html_css_files = ['custom.css']
 
 todo_include_todos = True
 
@@ -52,7 +54,9 @@ def preprocess_readme():
     if src.exists():
         content = src.read_text()
         content = re.sub(r"docs/", r"", content)
-        content = re.sub(r".rst", r".html", content)
+        content = re.sub(r"\.rst\b", r".html", content)
+        if not content.endswith("\n"):
+            content += "\n"
         tgt.write_text(content)
 
 preprocess_readme()