Skip to content

Commit 29f226c

Browse files
committed
docs index.rst pointed to README.rst
1 parent 824793a commit 29f226c

File tree

2 files changed

+4
-31
lines changed

2 files changed

+4
-31
lines changed

README.rst

Lines changed: 3 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ Sponsors
55

66
TinyUSB is funded by: Adafruit. Purchasing products from them helps to support this project.
77

8-
.. figure:: docs/assets/adafruit_logo.svg
8+
.. figure:: /docs/assets/adafruit_logo.svg
99
:alt: Adafruit Logo
1010
:target: https://www.adafruit.com
1111

1212
TinyUSB Project
1313
===============
1414

15-
.. figure:: docs/assets/logo.svg
15+
.. figure:: /docs/assets/logo.svg
1616
:alt: TinyUSB
1717

1818
TinyUSB is an open-source cross-platform USB Host/Device stack for
1919
embedded system, designed to be memory-safe with no dynamic allocation
2020
and thread-safe with all interrupt events are deferred then handled in
2121
the non-ISR task function. Check out the online `documentation <https://docs.tinyusb.org/>`__ for more details.
2222

23-
.. figure:: docs/assets/stack.svg
23+
.. figure:: /docs/assets/stack.svg
2424
:width: 500px
2525
:alt: stackup
2626

@@ -250,27 +250,6 @@ individually licensed especially those in ``lib`` and ``hw/mcu`` folder.
250250
Please make sure you understand all the license term for files you use
251251
in your project.
252252

253-
Docs
254-
====
255-
256-
- Info
257-
258-
- `Uses`_
259-
- `Changelog`_
260-
- `Contributors`_
261-
262-
- `Reference`_
263-
264-
- `Getting Started`_
265-
- `Supported Boards`_
266-
- `Dependencies`_
267-
- `Concurrency`_
268-
269-
- `Contributing`_
270-
271-
- `Code of Conduct`_
272-
- `Structure`_
273-
- `Porting`_
274253

275254
.. |Build Status| image:: https://github.com/hathach/tinyusb/actions/workflows/build.yml/badge.svg
276255
:target: https://github.com/hathach/tinyusb/actions

docs/index.rst

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
:hide-toc:
22

3-
*********
4-
TinyUSB
5-
*********
6-
7-
TinyUSB is an open-source cross-platform USB Host/Device stack for embedded systems,
8-
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.
9-
3+
.. include:: ../README.rst
104

115
.. toctree::
126
:caption: Index

0 commit comments

Comments
 (0)