templates
/
KiBot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[KiRi][DOCs] Updated

This commit is contained in:
Salvador E. Tropea 2023-12-29 13:21:17 -03:00
parent 33bd72073b
commit 19e2fb59b1
2 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/samples/generic_plot.kibot.yaml
View File

@ -1649,6 +1649,8 @@ outputs:
type: 'kiri' type: 'kiri'
dir: 'Example/kiri_dir' dir: 'Example/kiri_dir'
options: options:
# [string='#FFFFFF'] Color used for the background of the diff canvas
background_color: '#FFFFFF'
# [string='_builtin_classic'] Selects the color theme. Only applies to KiCad 6. # [string='_builtin_classic'] Selects the color theme. Only applies to KiCad 6.
# To use the KiCad 6 default colors select `_builtin_default`. # To use the KiCad 6 default colors select `_builtin_default`.
# Usually user colors are stored as `user`, but you can give it another name # Usually user colors are stored as `user`, but you can give it another name
@ -1658,11 +1660,14 @@ outputs:
dnf_filter: '_none' dnf_filter: '_none'
# [boolean=false] Avoid PCB and SCH images regeneration. Useful for incremental usage # [boolean=false] Avoid PCB and SCH images regeneration. Useful for incremental usage
keep_generated: false keep_generated: false
# [string='%f-%i%I%v.%x'] Filename for the output (%i=diff_pcb/diff_sch, %x=pdf). Affected by global options # [number=0] Maximum number of commits to include. Use 0 for all available commits
output: '%f-%i%I%v.%x' max_commits: 0
# [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. # [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
# A short-cut to use for simple cases where a variant is an overkill # A short-cut to use for simple cases where a variant is an overkill
pre_transform: '_none' pre_transform: '_none'
# [string='HEAD'] Starting point for the commits, can be a branch, a hash, etc.
# Note that this can be a revision-range, consult the gitrevisions manual for more information
revision: 'HEAD'
# [string=''] Board variant to apply # [string=''] Board variant to apply
variant: '' variant: ''
layers: all layers: all

5
docs/source/configuration/outputs/kiri.rst
View File

@ -40,13 +40,16 @@ Parameters:
To use the KiCad 6 default colors select `_builtin_default`. To use the KiCad 6 default colors select `_builtin_default`.
Usually user colors are stored as `user`, but you can give it another name. Usually user colors are stored as `user`, but you can give it another name.
- **keep_generated** :index:`: <pair: output - kiri - options; keep_generated>` [boolean=false] Avoid PCB and SCH images regeneration. Useful for incremental usage. - **keep_generated** :index:`: <pair: output - kiri - options; keep_generated>` [boolean=false] Avoid PCB and SCH images regeneration. Useful for incremental usage.
- **output** :index:`: <pair: output - kiri - options; output>` [string='%f-%i%I%v.%x'] Filename for the output (%i=diff_pcb/diff_sch, %x=pdf). Affected by global options. - ``background_color`` :index:`: <pair: output - kiri - options; background_color>` [string='#FFFFFF'] Color used for the background of the diff canvas.
- ``dnf_filter`` :index:`: <pair: output - kiri - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted. - ``dnf_filter`` :index:`: <pair: output - kiri - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted.
A short-cut to use for simple cases where a variant is an overkill. A short-cut to use for simple cases where a variant is an overkill.
- ``max_commits`` :index:`: <pair: output - kiri - options; max_commits>` [number=0] Maximum number of commits to include. Use 0 for all available commits.
- ``pre_transform`` :index:`: <pair: output - kiri - options; pre_transform>` [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. - ``pre_transform`` :index:`: <pair: output - kiri - options; pre_transform>` [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill. A short-cut to use for simple cases where a variant is an overkill.
- ``revision`` :index:`: <pair: output - kiri - options; revision>` [string='HEAD'] Starting point for the commits, can be a branch, a hash, etc.
Note that this can be a revision-range, consult the gitrevisions manual for more information.
- ``variant`` :index:`: <pair: output - kiri - options; variant>` [string=''] Board variant to apply. - ``variant`` :index:`: <pair: output - kiri - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - kiri; type>` [string=''] Type of output. - **type** :index:`: <pair: output - kiri; type>` [string=''] Type of output.