summaryrefslogtreecommitdiff
path: root/tools/gen_doc.py
diff options
context:
space:
mode:
authorHiFiPhile <[email protected]>2024-05-09 15:51:53 +0200
committerHiFiPhile <[email protected]>2024-05-09 15:51:53 +0200
commit36ce6fad8ca997804a569fe575584b45a1b5fc79 (patch)
treef79aa084a42438667b5e26b588a6f794c9ad1608 /tools/gen_doc.py
parentf607a99127cc9e8dfc3f716f977e6c1bfb6f7c2d (diff)
parent74e57499baac36c4cccf76549259905162031e41 (diff)
Merge branch 'master' into vendor_class_zero_length_transfer
Diffstat (limited to 'tools/gen_doc.py')
-rw-r--r--tools/gen_doc.py35
1 files changed, 35 insertions, 0 deletions
diff --git a/tools/gen_doc.py b/tools/gen_doc.py
new file mode 100644
index 000000000..c63294588
--- /dev/null
+++ b/tools/gen_doc.py
@@ -0,0 +1,35 @@
+import pandas as pd
+from tabulate import tabulate
+from pathlib import Path
+from get_deps import deps_all
+
+# TOP is tinyusb root dir
+TOP = Path(__file__).parent.parent.resolve()
+
+
+###########################################
+# Dependencies
+###########################################
+
+def gen_deps_doc():
+ deps_rst = Path(TOP) / "docs/reference/dependencies.rst"
+ df = pd.DataFrame.from_dict(deps_all, orient='index', columns=['Repo', 'Commit', 'Required by'])
+ df = df[['Repo', 'Commit', 'Required by']].sort_index()
+ df = df.rename_axis("Local Path")
+
+ outstr = f"""\
+************
+Dependencies
+************
+
+MCU low-level peripheral driver and external libraries for building TinyUSB examples
+
+{tabulate(df, headers="keys", tablefmt='rst')}
+"""
+
+ with deps_rst.open('w') as f:
+ f.write(outstr)
+
+
+if __name__ == "__main__":
+ gen_deps_doc()