hathach/tinyusb
1
0
Fork 0
mirror of https://github.com/hathach/tinyusb.git synced 2025-10-14 01:58:41 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #3290 from hathach/copilot/fix-dependency-link-in-docs

Browse Source 
docs: fix .rst links to use Sphinx :doc: role for proper HTML generation
This commit is contained in:
Ha Thach
2025-10-09 16:52:47 +07:00
committed by GitHub
parent 5cc9ade431 5a82112f5a
commit 20c8e92f3a
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/getting_started.rst
View File

@@ -50,7 +50,7 @@ To incorporate tinyusb to your project
Examples Examples
-------- --------
For your convenience, TinyUSB contains a handful of examples for both host and device with/without RTOS to quickly test the functionality as well as demonstrate how API should be used. Most examples will work on most of `the supported boards <boards.rst>`_. Firstly we need to ``git clone`` if not already For your convenience, TinyUSB contains a handful of examples for both host and device with/without RTOS to quickly test the functionality as well as demonstrate how API should be used. Most examples will work on most of :doc:`the supported boards <boards>`. Firstly we need to ``git clone`` if not already
.. code-block:: bash .. code-block:: bash
@@ -77,7 +77,7 @@ The hardware code is located in ``hw/bsp`` folder, and is organized by family/bo
$ cd examples/device/cdc_msc $ cd examples/device/cdc_msc
$ make BOARD=feather_nrf52840_express get-deps $ make BOARD=feather_nrf52840_express get-deps
You only need to do this once per family. Check out `complete list of dependencies and their designated path here <dependencies.rst>`_ You only need to do this once per family. Check out :doc:`complete list of dependencies and their designated path here <dependencies>`
Build Examples Build Examples
^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^