Skip to content

Commit b4252c4

Browse files
authored
Merge pull request #3015 from Dazza0/docs/fix_formatting
Fix .rst document formatting
2 parents 42213ef + 8f288e9 commit b4252c4

File tree

6 files changed

+271
-272
lines changed

6 files changed

+271
-272
lines changed

README.rst

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,7 @@ TinyUSB Project
1515
.. figure:: docs/assets/logo.svg
1616
:alt: TinyUSB
1717

18-
TinyUSB is an open-source cross-platform USB Host/Device stack for
19-
embedded system, designed to be memory-safe with no dynamic allocation
20-
and thread-safe with all interrupt events are deferred then handled in
21-
the non-ISR task function. Check out the online `documentation <https://docs.tinyusb.org/>`__ for more details.
18+
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.
2219

2320
.. figure:: docs/assets/stack.svg
2421
:width: 500px
@@ -32,7 +29,7 @@ the non-ISR task function. Check out the online `documentation <https://docs.tin
3229
├── hw
3330
│ ├── bsp # Supported boards source files
3431
│ └── mcu # Low level mcu core & peripheral drivers
35-
├── lib # Sources from 3rd party such as freeRTOS, fatfs ...
32+
├── lib # Sources from 3rd party such as FreeRTOS, FatFs ...
3633
├── src # All sources files for TinyUSB stack itself.
3734
├── test # Tests: unit test, fuzzing, hardware test
3835
└── tools # Files used internally
@@ -43,7 +40,7 @@ Getting started
4340

4441
See the `online documentation <https://docs.tinyusb.org>`_ for information about using TinyUSB and how it is implemented.
4542

46-
Check out `Getting Started`_ guide for adding TinyUSB to your project or building the examples. If you are new to TinyUSB, we recommend starting with the `cdc_msc` example. There is a handful of `Supported Boards`_ that should work out of the box.
43+
Check out `Getting Started`_ guide for adding TinyUSB to your project or building the examples. If you are new to TinyUSB, we recommend starting with the ``cdc_msc`` example. There is a handful of `Supported Boards`_ that should work out of the box.
4744

4845
We use `GitHub Discussions <https://github.com/hathach/tinyusb/discussions>`_ as our forum. It is a great place to ask questions and advice from the community or to discuss your TinyUSB-based projects.
4946

@@ -69,7 +66,7 @@ Supports multiple device configurations by dynamically changing USB descriptors,
6966
- Vendor-specific class support with generic In & Out endpoints. Can be used with MS OS 2.0 compatible descriptor to load winUSB driver without INF file.
7067
- `WebUSB <https://github.com/WICG/webusb>`__ with vendor-specific class
7168

72-
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>`_
69+
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>`_
7370

7471
Host Stack
7572
==========
@@ -80,7 +77,7 @@ Host Stack
8077
- Vendor serial over USB: FTDI, CP210x, CH34x
8178
- Hub with multiple-level support
8279

83-
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.
80+
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.
8481

8582
Power Delivery Stack
8683
====================

docs/contributing/code_of_conduct.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.. include:: ../../CODE_OF_CONDUCT.rst

0 commit comments

Comments
 (0)