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

[DOCs] Made the *type* more explicit in outputs help

This commit is contained in:
Salvador E. Tropea 2024-01-05 11:06:18 -03:00
parent 14fb810c0f
commit e9733d9559
48 changed files with 56 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/configuration/outputs/blender_export.rst
View File

@ -170,7 +170,7 @@ Parameters:
- ``texture_dpi`` :index:`: <pair: output - blender_export - options - pcb_import; texture_dpi>` [number=1016.0] [508-2032] Texture density in dots per inch.
- **type** :index:`: <pair: output - blender_export; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - blender_export; type>` 'blender_export'
- ``category`` :index:`: <pair: output - blender_export; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/boardview.rst
View File

@ -35,7 +35,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - boardview - options; variant>` [string=''] Board variant to apply.
Used for sub-PCBs.
- **type** :index:`: <pair: output - boardview; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - boardview; type>` 'boardview'
- ``category`` :index:`: <pair: output - boardview; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/bom.rst
View File

@ -307,7 +307,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - bom - options; variant>` [string=''] Board variant, used to determine which components
are output to the BoM..
- **type** :index:`: <pair: output - bom; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - bom; type>` 'bom'
- ``category`` :index:`: <pair: output - bom; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/compress.rst
View File

@ -47,7 +47,7 @@ Parameters:
- *remove_files* :index:`: <pair: output - compress - options; remove_files>` Alias for move_files.
- ``skip_not_run`` :index:`: <pair: output - compress - options; skip_not_run>` [boolean=false] Skip outputs with `run_by_default: false`.
- **type** :index:`: <pair: output - compress; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - compress; type>` 'compress'
- ``category`` :index:`: <pair: output - compress; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/copy_files.rst
View File

@ -73,7 +73,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - copy_files - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - copy_files; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - copy_files; type>` 'copy_files'
- ``category`` :index:`: <pair: output - copy_files; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/diff.rst
View File

@ -96,7 +96,7 @@ Parameters:
a refill, *unfill* forces a zone removal and *none* lets the zones unchanged.
Be careful with the cache when changing this setting.
- **type** :index:`: <pair: output - diff; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - diff; type>` 'diff'
- ``category`` :index:`: <pair: output - diff; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/download_datasheets.rst
View File

@ -39,7 +39,7 @@ Parameters:
It only makes sense if the `output` field makes their output different.
- ``variant`` :index:`: <pair: output - download_datasheets - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - download_datasheets; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - download_datasheets; type>` 'download_datasheets'
- ``category`` :index:`: <pair: output - download_datasheets; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/dxf.rst
View File

@ -82,7 +82,7 @@ Parameters:
- ``use_aux_axis_as_origin`` :index:`: <pair: output - dxf - options; use_aux_axis_as_origin>` [boolean=false] Use the auxiliary axis as origin for coordinates.
- ``variant`` :index:`: <pair: output - dxf - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - dxf; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - dxf; type>` 'dxf'
- ``category`` :index:`: <pair: output - dxf; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/dxf_sch_print.rst
View File

@ -42,7 +42,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - dxf_sch_print - options; variant>` [string=''] Board variant to apply.
Not fitted components are crossed.
- **type** :index:`: <pair: output - dxf_sch_print; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - dxf_sch_print; type>` 'dxf_sch_print'
- ``category`` :index:`: <pair: output - dxf_sch_print; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/excellon.rst
View File

@ -61,7 +61,7 @@ Parameters:
Used for sub-PCBs.
- ``zeros_format`` :index:`: <pair: output - excellon - options; zeros_format>` [string='DECIMAL_FORMAT'] [DECIMAL_FORMAT,SUPPRESS_LEADING,SUPPRESS_TRAILING,KEEP_ZEROS] How to handle the zeros.
- **type** :index:`: <pair: output - excellon; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - excellon; type>` 'excellon'
- ``category`` :index:`: <pair: output - excellon; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/gencad.rst
View File

@ -40,7 +40,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - gencad - options; variant>` [string=''] Board variant to apply.
Used for sub-PCBs.
- **type** :index:`: <pair: output - gencad; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - gencad; type>` 'gencad'
- ``category`` :index:`: <pair: output - gencad; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/gerb_drill.rst
View File

@ -53,7 +53,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - gerb_drill - options; variant>` [string=''] Board variant to apply.
Used for sub-PCBs.
- **type** :index:`: <pair: output - gerb_drill; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - gerb_drill; type>` 'gerb_drill'
- ``category`` :index:`: <pair: output - gerb_drill; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/gerber.rst
View File

@ -84,7 +84,7 @@ Parameters:
- ``use_aux_axis_as_origin`` :index:`: <pair: output - gerber - options; use_aux_axis_as_origin>` [boolean=false] Use the auxiliary axis as origin for coordinates.
- ``variant`` :index:`: <pair: output - gerber - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - gerber; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - gerber; type>` 'gerber'
- ``category`` :index:`: <pair: output - gerber; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/hpgl.rst
View File

@ -82,7 +82,7 @@ Parameters:
- ``uppercase_extensions`` :index:`: <pair: output - hpgl - options; uppercase_extensions>` [boolean=false] Use uppercase names for the extensions.
- ``variant`` :index:`: <pair: output - hpgl - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - hpgl; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - hpgl; type>` 'hpgl'
- ``category`` :index:`: <pair: output - hpgl; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/hpgl_sch_print.rst
View File

@ -44,7 +44,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - hpgl_sch_print - options; variant>` [string=''] Board variant to apply.
Not fitted components are crossed.
- **type** :index:`: <pair: output - hpgl_sch_print; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - hpgl_sch_print; type>` 'hpgl_sch_print'
- ``category`` :index:`: <pair: output - hpgl_sch_print; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/ibom.rst
View File

@ -90,7 +90,7 @@ Parameters:
- ``variants_whitelist`` :index:`: <pair: output - ibom - options; variants_whitelist>` [string=''] List of board variants to include in the BOM.
IBoM option, avoid using in conjunction with KiBot variants/filters.
- **type** :index:`: <pair: output - ibom; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - ibom; type>` 'ibom'
- ``category`` :index:`: <pair: output - ibom; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/info.rst
View File

@ -30,7 +30,7 @@ Parameters:
- ``environment`` :index:`: <pair: output - info - options; environment>` [string='names'] [names,none,full] List environment variables.
IMPORTANT: Don't use `full` unless you know you are not leaking sensitive information.
- **type** :index:`: <pair: output - info; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - info; type>` 'info'
- ``category`` :index:`: <pair: output - info; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/kibom.rst
View File

@ -130,7 +130,7 @@ Parameters:
variants with the ';' (semicolon) character.
This isn't related to the KiBot concept of variants.
- **type** :index:`: <pair: output - kibom; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - kibom; type>` 'kibom'
- ``category`` :index:`: <pair: output - kibom; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/kicost.rst
View File

@ -73,7 +73,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - kicost - options; variant>` [string=''] Board variant to apply.
Don't use the `kicost_variant` when using internal variants/filters.
- **type** :index:`: <pair: output - kicost; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - kicost; type>` 'kicost'
- ``category`` :index:`: <pair: output - kicost; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/kikit_present.rst
View File

@ -88,7 +88,7 @@ Parameters:
- ``template`` :index:`: <pair: output - kikit_present - options; template>` [string='default'] Path to a template directory or a name of built-in one.
See KiKit's doc/present.md for template specification.
- **type** :index:`: <pair: output - kikit_present; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - kikit_present; type>` 'kikit_present'
- ``category`` :index:`: <pair: output - kikit_present; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

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

@ -57,7 +57,7 @@ Parameters:
a refill, *unfill* forces a zone removal and *none* lets the zones unchanged.
Be careful with the *keep_generated* option when changing this setting.
- **type** :index:`: <pair: output - kiri; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - kiri; type>` 'kiri'
- ``category`` :index:`: <pair: output - kiri; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/navigate_results.rst
View File

@ -27,7 +27,7 @@ Parameters:
- **output** :index:`: <pair: output - navigate_results - options; output>` [string='%f-%i%I%v.%x'] Filename for the output (%i=html, %x=navigate). Affected by global options.
- ``skip_not_run`` :index:`: <pair: output - navigate_results - options; skip_not_run>` [boolean=false] Skip outputs with `run_by_default: false`.
- **type** :index:`: <pair: output - navigate_results; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - navigate_results; type>` 'navigate_results'
- ``category`` :index:`: <pair: output - navigate_results; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/netlist.rst
View File

@ -37,7 +37,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - netlist - options; variant>` [string=''] Board variant to apply.
Used for sub-PCBs.
- **type** :index:`: <pair: output - netlist; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - netlist; type>` 'netlist'
- ``category`` :index:`: <pair: output - netlist; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/panelize.rst
View File

@ -383,7 +383,7 @@ Parameters:
- ``units`` :index:`: <pair: output - panelize - options; units>` [string='mm'] [millimeters,inches,mils,mm,cm,dm,m,mil,inch,in] Units used when omitted.
- ``variant`` :index:`: <pair: output - panelize - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - panelize; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - panelize; type>` 'panelize'
- ``category`` :index:`: <pair: output - panelize; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/pcb2blender_tools.rst
View File

@ -55,7 +55,7 @@ Parameters:
- ``sub_boards_stacked_prefix`` :index:`: <pair: output - pcb2blender_tools - options; sub_boards_stacked_prefix>` [string='stacked\_'] Prefix used for the stack files.
- ``variant`` :index:`: <pair: output - pcb2blender_tools - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - pcb2blender_tools; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - pcb2blender_tools; type>` 'pcb2blender_tools'
- ``category`` :index:`: <pair: output - pcb2blender_tools; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/pcb_print.rst
View File

@ -152,7 +152,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - pcb_print - options; variant>` [string=''] Board variant to apply.
- ``via_color`` :index:`: <pair: output - pcb_print - options; via_color>` [string=''] Color used for through-hole `colored_vias`.
- **type** :index:`: <pair: output - pcb_print; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - pcb_print; type>` 'pcb_print'
- ``category`` :index:`: <pair: output - pcb_print; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/pcb_variant.rst
View File

@ -38,7 +38,7 @@ Parameters:
If it starts with `+` the text is concatenated.
- ``variant`` :index:`: <pair: output - pcb_variant - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - pcb_variant; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - pcb_variant; type>` 'pcb_variant'
- ``category`` :index:`: <pair: output - pcb_variant; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/pcbdraw.rst
View File

@ -129,7 +129,7 @@ Parameters:
Note that any other content from this layer will be included.
- ``warnings`` :index:`: <pair: output - pcbdraw - options; warnings>` [string='visible'] [visible,all,none] Using visible only the warnings about components in the visible side are generated.
- **type** :index:`: <pair: output - pcbdraw; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - pcbdraw; type>` 'pcbdraw'
- ``category`` :index:`: <pair: output - pcbdraw; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/pdf.rst
View File

@ -90,7 +90,7 @@ Parameters:
(i.e. always the default worksheet style, also problems expanding text variables).
The `pcb_print` output can do a better job for PDF, SVG, PS, EPS and PNG outputs.
- **scaling** :index:`: <pair: output - pdf; scaling>` [number=1] Scale factor (0 means autoscaling).
- **type** :index:`: <pair: output - pdf; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - pdf; type>` 'pdf'
- ``category`` :index:`: <pair: output - pdf; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/pdf_pcb_print.rst
View File

@ -64,7 +64,7 @@ Parameters:
If it starts with `+` the text is concatenated.
- ``variant`` :index:`: <pair: output - pdf_pcb_print - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - pdf_pcb_print; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - pdf_pcb_print; type>` 'pdf_pcb_print'
- ``category`` :index:`: <pair: output - pdf_pcb_print; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/pdf_sch_print.rst
View File

@ -43,7 +43,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - pdf_sch_print - options; variant>` [string=''] Board variant to apply.
Not fitted components are crossed.
- **type** :index:`: <pair: output - pdf_sch_print; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - pdf_sch_print; type>` 'pdf_sch_print'
- ``category`` :index:`: <pair: output - pdf_sch_print; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/pdfunite.rst
View File

@ -38,7 +38,7 @@ Parameters:
- ``use_external_command`` :index:`: <pair: output - pdfunite - options; use_external_command>` [boolean=false] Use the `pdfunite` tool instead of PyPDF2 Python module.
- **type** :index:`: <pair: output - pdfunite; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - pdfunite; type>` 'pdfunite'
- ``category`` :index:`: <pair: output - pdfunite; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/populate.rst
View File

@ -49,7 +49,7 @@ Parameters:
The `simple.handlebars` template is a built-in template.
- ``variant`` :index:`: <pair: output - populate - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - populate; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - populate; type>` 'populate'
- ``category`` :index:`: <pair: output - populate; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/position.rst
View File

@ -56,7 +56,7 @@ Parameters:
Supported by the gerber format.
- ``variant`` :index:`: <pair: output - position - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - position; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - position; type>` 'position'
- ``category`` :index:`: <pair: output - position; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/ps.rst
View File

@ -87,7 +87,7 @@ Parameters:
- ``width_adjust`` :index:`: <pair: output - ps - options; width_adjust>` [number=0] This width factor is intended to compensate PS printers/plotters that do not strictly obey line width settings.
Only used to plot pads and tracks.
- **type** :index:`: <pair: output - ps; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - ps; type>` 'ps'
- ``category`` :index:`: <pair: output - ps; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/ps_sch_print.rst
View File

@ -42,7 +42,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - ps_sch_print - options; variant>` [string=''] Board variant to apply.
Not fitted components are crossed.
- **type** :index:`: <pair: output - ps_sch_print; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - ps_sch_print; type>` 'ps_sch_print'
- ``category`` :index:`: <pair: output - ps_sch_print; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/qr_lib.rst
View File

@ -48,7 +48,7 @@ Parameters:
- ``reference`` :index:`: <pair: output - qr_lib - options; reference>` [string='QR'] The reference prefix.
- ``use_sch_dir`` :index:`: <pair: output - qr_lib - options; use_sch_dir>` [boolean=true] Generate the libs relative to the schematic/PCB dir.
- **type** :index:`: <pair: output - qr_lib; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - qr_lib; type>` 'qr_lib'
- ``category`` :index:`: <pair: output - qr_lib; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/render_3d.rst
View File

@ -101,7 +101,7 @@ Parameters:
In this case the value is interpreted as a time-out..
- ``width`` :index:`: <pair: output - render_3d - options; width>` [number=1280] Image width (aprox.).
- **type** :index:`: <pair: output - render_3d; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - render_3d; type>` 'render_3d'
- ``category`` :index:`: <pair: output - render_3d; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/report.rst
View File

@ -45,7 +45,7 @@ Parameters:
diameter can be reduced to accommodate the correct annular ring values.
Use 0 to disable it.
- **type** :index:`: <pair: output - report; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - report; type>` 'report'
- ``category`` :index:`: <pair: output - report; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/sch_variant.rst
View File

@ -36,7 +36,7 @@ Parameters:
If it starts with `+` the text is concatenated.
- ``variant`` :index:`: <pair: output - sch_variant - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - sch_variant; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - sch_variant; type>` 'sch_variant'
- ``category`` :index:`: <pair: output - sch_variant; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/stencil_3d.rst
View File

@ -56,7 +56,7 @@ Parameters:
side contains solder paste.
- ``variant`` :index:`: <pair: output - stencil_3d - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - stencil_3d; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - stencil_3d; type>` 'stencil_3d'
- ``category`` :index:`: <pair: output - stencil_3d; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/stencil_for_jig.rst
View File

@ -57,7 +57,7 @@ Parameters:
- ``tolerance`` :index:`: <pair: output - stencil_for_jig - options; tolerance>` [number=0.05] Enlarges the register by the tolerance value [mm].
- ``variant`` :index:`: <pair: output - stencil_for_jig - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - stencil_for_jig; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - stencil_for_jig; type>` 'stencil_for_jig'
- ``category`` :index:`: <pair: output - stencil_for_jig; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/step.rst
View File

@ -53,7 +53,7 @@ Parameters:
- ``subst_models`` :index:`: <pair: output - step - options; subst_models>` [boolean=true] Substitute STEP or IGS models with the same name in place of VRML models.
- ``variant`` :index:`: <pair: output - step - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - step; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - step; type>` 'step'
- ``category`` :index:`: <pair: output - step; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/svg.rst
View File

@ -104,7 +104,7 @@ Parameters:
- ``uppercase_extensions`` :index:`: <pair: output - svg - options; uppercase_extensions>` [boolean=false] Use uppercase names for the extensions.
- ``variant`` :index:`: <pair: output - svg - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - svg; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - svg; type>` 'svg'
- ``category`` :index:`: <pair: output - svg; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/svg_pcb_print.rst
View File

@ -65,7 +65,7 @@ Parameters:
If it starts with `+` the text is concatenated.
- ``variant`` :index:`: <pair: output - svg_pcb_print - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - svg_pcb_print; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - svg_pcb_print; type>` 'svg_pcb_print'
- ``category`` :index:`: <pair: output - svg_pcb_print; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/svg_sch_print.rst
View File

@ -43,7 +43,7 @@ Parameters:
- ``variant`` :index:`: <pair: output - svg_sch_print - options; variant>` [string=''] Board variant to apply.
Not fitted components are crossed.
- **type** :index:`: <pair: output - svg_sch_print; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - svg_sch_print; type>` 'svg_sch_print'
- ``category`` :index:`: <pair: output - svg_sch_print; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

2
docs/source/configuration/outputs/vrml.rst
View File

@ -65,7 +65,7 @@ Parameters:
When disabled the `ref_x`, `ref_y` and `ref_units` will be used.
- ``variant`` :index:`: <pair: output - vrml - options; variant>` [string=''] Board variant to apply.
- **type** :index:`: <pair: output - vrml; type>` [string=''] Type of output.
- **type** :index:`: <pair: output - vrml; type>` 'vrml'
- ``category`` :index:`: <pair: output - vrml; category>` [string|list(string)=''] The category for this output. If not specified an internally defined category is used.
Categories looks like file system paths, i.e. **PCB/fabrication/gerber**.
The categories are currently used for `navigate_results`.

13
kibot/config_reader.py
View File

@ -789,9 +789,10 @@ def print_output_options(name, cl, indent, context=None, skip_keys=False):
if rst_mode:
ind_base_sp += ' '
for k, v in sorted(obj.get_attrs_gen(), key=lambda x: not obj.is_basic_option(x[0])):
if k == 'type' and indent == ind_size:
# Type is fixed for an output
continue
if k == 'type':
if indent == ind_size:
# Type is fixed for an output
continue
if not num_opts:
# We found one, put the title
if rst_mode:
@ -801,6 +802,10 @@ def print_output_options(name, cl, indent, context=None, skip_keys=False):
if rst_mode:
print()
help, alias, is_alias = obj.get_doc(k)
dot = True
if k == 'type' and not indent:
help = f"*'{name}'"
dot = False
is_basic = False
if help and help[0] == '*':
help = help[1:]
@ -822,7 +827,7 @@ def print_output_options(name, cl, indent, context=None, skip_keys=False):
# Index entry
preface = preface[:-2] + f' :index:`: <pair: {context}; {k}>` '
clines = len(lines)
print('{}{}{}'.format(preface, adapt_text(lines[0].strip()), '.' if clines == 1 else ''))
print('{}{}{}'.format(preface, adapt_text(lines[0].strip()), '.' if clines == 1 and dot else ''))
if rst_mode:
if skip_keys:
ind_help = (indent+ind_size)*' '