Merge pull request #2917 from hathach/board-doc

update docs, embed metadata to family.c and board.h

Author: hathach

README.rst

@@ -5,13 +5,16 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import re
+from pathlib import Path
+
 # -- Path setup --------------------------------------------------------------
 
 
 # -- Project information -----------------------------------------------------
 
 project = 'TinyUSB'
-copyright = '2021, Ha Thach'
+copyright = '2024, Ha Thach'
 author = 'Ha Thach'
 
 
@@ -40,3 +43,16 @@
 }
 
 todo_include_todos = True
+
+# pre-process path in README.rst
+def preprocess_readme():
+    """Modify figure paths in README.rst for Sphinx builds."""
+    src = Path(__file__).parent.parent / "README.rst"
+    tgt = Path(__file__).parent.parent / "README_processed.rst"
+    if src.exists():
+        content = src.read_text()
+        content = re.sub(r"docs/", r"", content)
+        content = re.sub(r".rst", r".html", content)
+        tgt.write_text(content)
+
+preprocess_readme()

docs/conf.py

@@ -1 +1 @@
-../../CODE_OF_CONDUCT.rst
+.. include:: ../../CODE_OF_CONDUCT.rst

docs/contributing/code_of_conduct.rst

@@ -19,5 +19,4 @@ Index
    :maxdepth: 2
 
    code_of_conduct
-   structure
    porting

docs/contributing/index.rst

@@ -1,12 +1,6 @@
 :hide-toc:
 
-*********
-TinyUSB
-*********
-
-TinyUSB is an open-source cross-platform USB Host/Device stack for embedded systems,
-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.
-
+.. include:: ../README_processed.rst
 
 .. toctree::
    :caption: Index

docs/contributing/structure.rst

@@ -17,7 +17,6 @@ General
 - Build ARM IAR with CircleCI
 - Improve HIL with dual/host_info_to_device_cdc optional for pico/pico2, enable dwc2 dma test
 
-
 API Changes
 -----------
 
@@ -31,7 +30,6 @@ API Changes
   - ``CFG_TUD/TUH_DWC2_SLAVE_ENABLE`` enable dwc2 slave mode
   - ``CFG_TUD/TUH_DWC2_DMA_ENABLE`` enable dwc2 dma mode
 
-
 Controller Driver (DCD & HCD)
 -----------------------------
 

docs/index.rst

@@ -1 +1 @@
-../../CONTRIBUTORS.rst
+.. include:: ../../CONTRIBUTORS.rst

docs/info/changelog.rst

@@ -8,6 +8,5 @@ Index
 .. toctree::
    :maxdepth: 2
 
-   uses
    changelog
    contributors