Add doc generation workflow (#1)

Co-authored-by: an.tsouchlos <an.tsouchlos@users.noreply.github.com>
Reviewed-on: #1
Co-authored-by: Andreas Tsouchlos <an.tsouchlos@gmail.com>
Co-committed-by: Andreas Tsouchlos <an.tsouchlos@gmail.com>

.gitattributes

@@ -0,0 +1,7 @@
+*.csv filter=bom_csv
+*.html filter=bom_html
+*.gbr filter=gerber
+*.gbrjob filter=gbrjob
+*.xml filter=xml
+*.kicad_pcb filter=kicad_pcb_f
+*.net filter=net_filter

.gitconfig

@@ -0,0 +1,20 @@
+[filter "bom_csv"]
+	clean = sed -E 's/^BoM Date:.*$/BoM Date:Date/'
+	smudge = sed -E \"s/BoM Date:Date/BoM Date:,`date +\\\"%a %d %b %Y %X %:::z\\\"`/\"
+[filter "bom_html"]
+	clean = sed -E 's/^<tr><td>BoM Date<\\/td><td>.*$/<tr><td>BoM Date<\\/td><td>Date<\\/td><\\/tr>/'
+	smudge = sed -E \"s/<tr><td>BoM Date<\\/td><td>Date<\\/td><\\/tr>/<tr><td>BoM Date<\\/td><td>`date +\\\"%a %d %b %Y %X %:::z\\\"`<\\/td><\\/tr>/\"
+[filter "gerber"]
+	clean = sed -E -e 's/^%TF.CreationDate,.*$/%TF.CreationDate,Date%/' -e 's/^G04 Created by KiCad.*$/G04 Created by KiCad*/'
+	smudge = sed -E \"s/%TF.CreationDate,Date%/%TF.CreationDate,`date +%Y-%m-%dT%H:%M:%S%:z`/\"
+[filter "gbrjob"]
+	clean = sed -E 's/\"CreationDate\":.*/\"CreationDate\":  \"Date\"/'
+	smudge = sed -E \"s/\\\"CreationDate\\\":  \\\"Date\\\"/\\\"CreationDate\\\":  \\\"`date +%Y-%m-%dT%H:%M:%S%:z`\\\"/\"
+[filter "xml"]
+	clean = sed -E -e 's/^        <date>.*<\\/date>/        <date>Date2<\\/date>/' -e 's/^    <date>.*<\\/date>/    <date>Date1<\\/date>/'
+	smudge = sed -E -e \"s/<date>Date1<\\/date>/<date>`date +\\\"%a %d %b %Y %X %:::z\\\"`<\\/date>/\" -e \"s/<date>Date2<\\/date>/<date>`date +\\\"%Y-%m-%d\\\"`<\\/date>/\"
+[filter "kicad_pcb_f"]
+	clean = sed -E 's/\\(host pcbnew ([[:digit:]]+\\.[[:digit:]]+\\.[[:digit:]]+).*/\\(host pcbnew \\1\\)/'
+[filter "net_filter"]
+	clean = sed -E -e 's/\\(date \\\".*\\\"\\)/\\(date \\\"Date\\\"\\)/'
+	smudge = sed -E -e \"s/\\(date \\\"Date\\\"\\)/\\(date \\\"`date +\\\"%a %d %b %Y %X %:::z\\\"`\\\"\\)/\"

.gitea/workflows/doc-generation.yml

@@ -0,0 +1,22 @@
+name: docs-generation
+
+on:
+  pull_request:
+    paths:
+      - '**.sch'
+      - '**.kicad_pcb'
+
+jobs:
+  docs-generation:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: INTI-CMNB/KiBot@v1.8.1
+      with:
+        config: config.kibot.yaml
+        schema: 'CommonSense.kicad_sch'
+        board: 'CommonSense.kicad_pcb'
+    - name: upload results
+      uses: stefanzweifel/git-auto-commit-action@v5
+      with:
+        commit_message: 'Update Docs'

README.md

@@ -1,10 +1,17 @@
 # CommonSense
 
-A BLE-based PCB for measuring humidity and temperature
+A BLE-based PCB for measuring humidity and temperature.
 
-## Downloading libraries
-
-After cloning, the libraries have to be downloaded using
+After cloning, the libraries can be downloaded using
 ```bash
 $ git submodule update --init
 ```
+
+## PCB
+
+<img width=400 src="./doc/generated/CommonSense-top.svg" />
+<img width=400 src="./doc/generated/CommonSense-bottom.svg" />
+
+## Schematic
+
+<img src="./doc/generated/CommonSense-schematic.svg" />

config.kibot.yaml

@@ -0,0 +1,50 @@
+kibot:
+  version: 1
+
+outputs:
+  - name: 'schematic pdf'
+    comment: 'Schematic pdf generation'
+    type: 'pdf_sch_print'
+    dir: 'doc/generated'
+  - name: 'schematic svg'
+    comment: 'Schematic pdf generation'
+    type: 'svg_sch_print'
+    dir: 'doc/generated'
+    options:
+      background_color: true
+  - name: 'pcbdraw top svg'
+    comment: 'PCB top image generation'
+    type: 'pcbdraw'
+    dir: 'doc/generated'
+    options:
+      bottom: false
+      style: 'set-blue-cu'
+      show_components: 'none'
+  - name: 'pcbdraw top pdn'
+    comment: 'PCB top image generation'
+    type: 'pcbdraw'
+    dir: 'doc/generated'
+    options:
+      format: 'png'
+      dpi: 600
+      bottom: false
+      style: 'set-blue-cu'
+      show_components: 'none'
+  - name: 'pcbdraw bottom svg'
+    comment: 'PCB bottom image generation'
+    type: 'pcbdraw'
+    options:
+      bottom: true
+      style: 'set-blue-cu'
+      show_components: 'none'
+    dir: 'doc/generated'
+  - name: 'pcbdraw bottom png'
+    comment: 'PCB bottom image generation'
+    type: 'pcbdraw'
+    options:
+      format: 'png'
+      dpi: 600
+      bottom: true
+      style: 'set-blue-cu'
+      show_components: 'none'
+    dir: 'doc/generated'