diff options
| author | Ha Thach <[email protected]> | 2024-12-27 21:24:36 +0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-12-27 21:24:36 +0700 |
| commit | 2495563600f1cd2220d740895fad701dd48f1fb6 (patch) | |
| tree | b953b303b8295fa3b0043288f24794c0e58937ca /docs/contributing | |
| parent | 86ad6e56c1700e85f1c5678607a762cfe3aa2f47 (diff) | |
| parent | de38e53271038d67812715a2086966ec84d6b540 (diff) | |
Merge pull request #2917 from hathach/board-doc
update docs, embed metadata to family.c and board.h
Diffstat (limited to 'docs/contributing')
| l--------- | docs/contributing/code_of_conduct.rst | 2 | ||||
| -rw-r--r-- | docs/contributing/index.rst | 1 | ||||
| -rw-r--r-- | docs/contributing/structure.rst | 59 |
3 files changed, 1 insertions, 61 deletions
diff --git a/docs/contributing/code_of_conduct.rst b/docs/contributing/code_of_conduct.rst index b52bf14c5..fb1859c75 120000 --- a/docs/contributing/code_of_conduct.rst +++ b/docs/contributing/code_of_conduct.rst @@ -1 +1 @@ -../../CODE_OF_CONDUCT.rst
\ No newline at end of file +.. include:: ../../CODE_OF_CONDUCT.rst
\ No newline at end of file diff --git a/docs/contributing/index.rst b/docs/contributing/index.rst index 7ff79cb32..78933a3ca 100644 --- a/docs/contributing/index.rst +++ b/docs/contributing/index.rst @@ -19,5 +19,4 @@ Index :maxdepth: 2 code_of_conduct - structure porting diff --git a/docs/contributing/structure.rst b/docs/contributing/structure.rst deleted file mode 100644 index e8c658850..000000000 --- a/docs/contributing/structure.rst +++ /dev/null @@ -1,59 +0,0 @@ -********* -Structure -********* - -Tree -==== - -:: - - . - ├── docs - ├── examples - ├── hw - │ ├── bsp - │ └── mcu - ├── lib - ├── src - ├── test - └── tools - -docs ----- - -Documentation - -examples --------- - -Sample with Makefile build support - -hw/bsp ------- - -Supported boards source files - -hw/mcu ------- - -Low level mcu core & peripheral drivers - -lib ---- - -Sources from 3rd party such as freeRTOS, fatfs ... - -src ---- - -All sources files for TinyUSB stack itself. - -test ----- - -Unit tests for the stack - -tools ------ - -Files used internally |