Move param doc (#49)

moved param description pages to main repo
jomjol · Jan 31, 2024 · ab02887 · ab02887
1 parent 4e19d38
commit ab02887
Show file tree

Hide file tree

Showing 93 changed files with 7 additions and 893 deletions.
diff --git a/.github/workflows/build-docs.yaml b/.github/workflows/build-docs.yaml
@@ -19,18 +19,18 @@ jobs:
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:
       - name: Cache PIP
-        uses: actions/cache@v3
+        uses: actions/cache@v4
         with:
           path: ~/.cache/pip
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: |
             ${{ runner.os }}-pip-
           
       # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
       - run: |
           pip install --upgrade pip && pip install mkdocs mkdocs-gen-files mkdocs-awesome-pages-plugin mkdocs-material mkdocs-enumerate-headings-plugin
           git config user.name 'github-actions[bot]'
@@ -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

diff --git a/param-docs/.gitignore b/param-docs/.gitignore
@@ -0,0 +1 @@
+AI-on-the-edge-device 
diff --git a/param-docs/concat-parameter-pages.py b/param-docs/concat-parameter-pages.py
@@ -10,7 +10,7 @@
 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"

diff --git a/param-docs/expert-params.txt b/param-docs/expert-params.txt
diff --git a/param-docs/generate-template-param-doc-pages.py b/param-docs/generate-template-param-doc-pages.py
diff --git a/param-docs/hidden-in-ui.txt b/param-docs/hidden-in-ui.txt
diff --git a/param-docs/parameter-pages/Alignment/AlignmentAlgo.md b/param-docs/parameter-pages/Alignment/AlignmentAlgo.md
diff --git a/param-docs/parameter-pages/Alignment/FlipImageSize.md b/param-docs/parameter-pages/Alignment/FlipImageSize.md
diff --git a/param-docs/parameter-pages/Alignment/InitialMirror.md b/param-docs/parameter-pages/Alignment/InitialMirror.md
diff --git a/param-docs/parameter-pages/Alignment/InitialRotate.md b/param-docs/parameter-pages/Alignment/InitialRotate.md
diff --git a/param-docs/parameter-pages/Alignment/SearchFieldX.md b/param-docs/parameter-pages/Alignment/SearchFieldX.md
diff --git a/param-docs/parameter-pages/Alignment/SearchFieldY.md b/param-docs/parameter-pages/Alignment/SearchFieldY.md
diff --git a/param-docs/parameter-pages/Analog/CNNGoodThreshold.md b/param-docs/parameter-pages/Analog/CNNGoodThreshold.md
diff --git a/param-docs/parameter-pages/Analog/ExtendedResolution.md b/param-docs/parameter-pages/Analog/ExtendedResolution.md
diff --git a/param-docs/parameter-pages/Analog/Model.md b/param-docs/parameter-pages/Analog/Model.md
diff --git a/param-docs/parameter-pages/Analog/ROIImagesLocation.md b/param-docs/parameter-pages/Analog/ROIImagesLocation.md
diff --git a/param-docs/parameter-pages/Analog/ROIImagesRetention.md b/param-docs/parameter-pages/Analog/ROIImagesRetention.md
diff --git a/param-docs/parameter-pages/AutoTimer/AutoStart.md b/param-docs/parameter-pages/AutoTimer/AutoStart.md
diff --git a/param-docs/parameter-pages/AutoTimer/Interval.md b/param-docs/parameter-pages/AutoTimer/Interval.md
diff --git a/param-docs/parameter-pages/DataLogging/DataFilesRetention.md b/param-docs/parameter-pages/DataLogging/DataFilesRetention.md
diff --git a/param-docs/parameter-pages/DataLogging/DataLogActive.md b/param-docs/parameter-pages/DataLogging/DataLogActive.md
diff --git a/param-docs/parameter-pages/Debug/LogLevel.md b/param-docs/parameter-pages/Debug/LogLevel.md
diff --git a/param-docs/parameter-pages/Debug/LogfilesRetention.md b/param-docs/parameter-pages/Debug/LogfilesRetention.md
diff --git a/param-docs/parameter-pages/Digits/CNNGoodThreshold.md b/param-docs/parameter-pages/Digits/CNNGoodThreshold.md
diff --git a/param-docs/parameter-pages/Digits/Model.md b/param-docs/parameter-pages/Digits/Model.md
diff --git a/param-docs/parameter-pages/Digits/ROIImagesLocation.md b/param-docs/parameter-pages/Digits/ROIImagesLocation.md
diff --git a/param-docs/parameter-pages/Digits/ROIImagesRetention.md b/param-docs/parameter-pages/Digits/ROIImagesRetention.md