This commit is contained in:
CaCO3
2024-01-31 22:09:15 +01:00
parent 4bee43322c
commit 528acce78d
4 changed files with 13 additions and 3 deletions

View File

@@ -39,8 +39,8 @@ jobs:
- name: Generate Parameter Page
run: |
cd param-docs
python generate-template-param-doc-pages.py # Creates a templated page for each parameter which does not yet have a page
tree parameter-pages
# Fetch the parameter pages from the main repo
git clone https://github.com/jomjol/AI-on-the-edge-device.git
python concat-parameter-pages.py
- name: Store Documentation in the gh-pages branch so it gets pushed to the website

1
param-docs/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
AI-on-the-edge-device

View File

@@ -10,7 +10,7 @@ import glob
sectionsLogicallyOrdered = ["TakeImage", "Alignment", "Digits", "Analog", "PostProcessing",
"MQTT", "InfluxDB", "InfluxDBv2", "GPIO", "AutoTimer", "DataLogging", "Debug", "System"]
parameterDocsFolder = "parameter-pages"
parameterDocsFolder = "AI-on-the-edge-device/param-docs/parameter-pages/"
docsMainFolder = "../docs"
parameterOverviewFile = "Parameters.md"
parameterOverviewTemplateFile = "./templates/overview.md"

View File

@@ -0,0 +1,9 @@
# Parameters
This page lists all available [Configuration](../Configuration) Parameters.
If a **parameter** or **section** has a tick box on its left side, you can disable it.
In such case the functionality gets disabled respectively the default values will be used.
!!! 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!
<hr style="border:2px solid">