Add doc generation workflow
This commit is contained in:
parent
a67b8fe123
commit
b082102c26
22
.github/workflows/doc-generation.yml
vendored
Normal file
22
.github/workflows/doc-generation.yml
vendored
Normal file
@ -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'
|
||||||
50
config.kibot.yaml
Normal file
50
config.kibot.yaml
Normal file
@ -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'
|
||||||
Loading…
Reference in New Issue
Block a user