mirror of
https://github.com/jomjol/AI-on-the-edge-device-docs.git
synced 2026-01-30 22:35:04 +03:00
.
This commit is contained in:
4
.github/workflows/build-docs.yaml
vendored
4
.github/workflows/build-docs.yaml
vendored
@@ -39,8 +39,8 @@ jobs:
|
|||||||
- name: Generate Parameter Page
|
- name: Generate Parameter Page
|
||||||
run: |
|
run: |
|
||||||
cd param-docs
|
cd param-docs
|
||||||
python generate-template-param-doc-pages.py # Creates a templated page for each parameter which does not yet have a page
|
# Fetch the parameter pages from the main repo
|
||||||
tree parameter-pages
|
git clone https://github.com/jomjol/AI-on-the-edge-device.git
|
||||||
python concat-parameter-pages.py
|
python concat-parameter-pages.py
|
||||||
|
|
||||||
- name: Store Documentation in the gh-pages branch so it gets pushed to the website
|
- name: Store Documentation in the gh-pages branch so it gets pushed to the website
|
||||||
|
|||||||
1
param-docs/.gitignore
vendored
Normal file
1
param-docs/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
AI-on-the-edge-device
|
||||||
@@ -10,7 +10,7 @@ import glob
|
|||||||
sectionsLogicallyOrdered = ["TakeImage", "Alignment", "Digits", "Analog", "PostProcessing",
|
sectionsLogicallyOrdered = ["TakeImage", "Alignment", "Digits", "Analog", "PostProcessing",
|
||||||
"MQTT", "InfluxDB", "InfluxDBv2", "GPIO", "AutoTimer", "DataLogging", "Debug", "System"]
|
"MQTT", "InfluxDB", "InfluxDBv2", "GPIO", "AutoTimer", "DataLogging", "Debug", "System"]
|
||||||
|
|
||||||
parameterDocsFolder = "parameter-pages"
|
parameterDocsFolder = "AI-on-the-edge-device/param-docs/parameter-pages/"
|
||||||
docsMainFolder = "../docs"
|
docsMainFolder = "../docs"
|
||||||
parameterOverviewFile = "Parameters.md"
|
parameterOverviewFile = "Parameters.md"
|
||||||
parameterOverviewTemplateFile = "./templates/overview.md"
|
parameterOverviewTemplateFile = "./templates/overview.md"
|
||||||
|
|||||||
9
param-docs/templates/overview.md
Normal file
9
param-docs/templates/overview.md
Normal 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">
|
||||||
Reference in New Issue
Block a user