mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2025-12-17 03:44:14 +03:00
Auto gen parameter doc (#14)
* added script to generate parameter documentation * extended readme * added templated parameter pages * Update build-docs.yaml * . * . --------- Co-authored-by: CaCO3 <caco@ruinelli.ch>
This commit is contained in:
7
generate-param-docs/templates/overview.md
Normal file
7
generate-param-docs/templates/overview.md
Normal file
@@ -0,0 +1,7 @@
|
||||
# Parameters
|
||||
This page lists all available [Configuration](../Configuration) Parameters.
|
||||
|
||||
!!! Note
|
||||
This is an auto-generated page! See the [README](https://github.com/jomjol/AI-on-the-edge-device-docs/blob/main/README.md) for details!
|
||||
|
||||
---
|
||||
6
generate-param-docs/templates/parameter.md
Normal file
6
generate-param-docs/templates/parameter.md
Normal file
@@ -0,0 +1,6 @@
|
||||
# Parameter `$NAME`
|
||||
Default Value: `$DEFAULT`
|
||||
|
||||
## Description
|
||||
Please fill me with an explanation and useful links
|
||||
|
||||
Reference in New Issue
Block a user