diff --git a/docs/source/configuration/outputs/blender_export.rst b/docs/source/configuration/outputs/blender_export.rst index 5b9d1669..5004ea81 100644 --- a/docs/source/configuration/outputs/blender_export.rst +++ b/docs/source/configuration/outputs/blender_export.rst @@ -170,7 +170,7 @@ Parameters: - ``texture_dpi`` :index:`: ` [number=1016.0] [508-2032] Texture density in dots per inch. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'blender_export' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/boardview.rst b/docs/source/configuration/outputs/boardview.rst index 63093b5b..6b876377 100644 --- a/docs/source/configuration/outputs/boardview.rst +++ b/docs/source/configuration/outputs/boardview.rst @@ -35,7 +35,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Used for sub-PCBs. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'boardview' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/bom.rst b/docs/source/configuration/outputs/bom.rst index aef86554..78bee665 100644 --- a/docs/source/configuration/outputs/bom.rst +++ b/docs/source/configuration/outputs/bom.rst @@ -307,7 +307,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant, used to determine which components are output to the BoM.. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'bom' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/compress.rst b/docs/source/configuration/outputs/compress.rst index 43cf2398..598fc3f2 100644 --- a/docs/source/configuration/outputs/compress.rst +++ b/docs/source/configuration/outputs/compress.rst @@ -47,7 +47,7 @@ Parameters: - *remove_files* :index:`: ` Alias for move_files. - ``skip_not_run`` :index:`: ` [boolean=false] Skip outputs with `run_by_default: false`. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'compress' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/copy_files.rst b/docs/source/configuration/outputs/copy_files.rst index d8142860..b7c07207 100644 --- a/docs/source/configuration/outputs/copy_files.rst +++ b/docs/source/configuration/outputs/copy_files.rst @@ -73,7 +73,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'copy_files' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/diff.rst b/docs/source/configuration/outputs/diff.rst index 59bc07f0..beb8c445 100644 --- a/docs/source/configuration/outputs/diff.rst +++ b/docs/source/configuration/outputs/diff.rst @@ -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:`: ` [string=''] Type of output. +- **type** :index:`: ` 'diff' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/download_datasheets.rst b/docs/source/configuration/outputs/download_datasheets.rst index ba7ae1d6..bd95c7b1 100644 --- a/docs/source/configuration/outputs/download_datasheets.rst +++ b/docs/source/configuration/outputs/download_datasheets.rst @@ -39,7 +39,7 @@ Parameters: It only makes sense if the `output` field makes their output different. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'download_datasheets' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/dxf.rst b/docs/source/configuration/outputs/dxf.rst index 02dd1283..51aaaeea 100644 --- a/docs/source/configuration/outputs/dxf.rst +++ b/docs/source/configuration/outputs/dxf.rst @@ -82,7 +82,7 @@ Parameters: - ``use_aux_axis_as_origin`` :index:`: ` [boolean=false] Use the auxiliary axis as origin for coordinates. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'dxf' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/dxf_sch_print.rst b/docs/source/configuration/outputs/dxf_sch_print.rst index 1facb11a..b87e532a 100644 --- a/docs/source/configuration/outputs/dxf_sch_print.rst +++ b/docs/source/configuration/outputs/dxf_sch_print.rst @@ -42,7 +42,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Not fitted components are crossed. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'dxf_sch_print' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/excellon.rst b/docs/source/configuration/outputs/excellon.rst index 0baf50ed..8466ecff 100644 --- a/docs/source/configuration/outputs/excellon.rst +++ b/docs/source/configuration/outputs/excellon.rst @@ -61,7 +61,7 @@ Parameters: Used for sub-PCBs. - ``zeros_format`` :index:`: ` [string='DECIMAL_FORMAT'] [DECIMAL_FORMAT,SUPPRESS_LEADING,SUPPRESS_TRAILING,KEEP_ZEROS] How to handle the zeros. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'excellon' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/gencad.rst b/docs/source/configuration/outputs/gencad.rst index 34f1a8de..c63bbec4 100644 --- a/docs/source/configuration/outputs/gencad.rst +++ b/docs/source/configuration/outputs/gencad.rst @@ -40,7 +40,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Used for sub-PCBs. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'gencad' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/gerb_drill.rst b/docs/source/configuration/outputs/gerb_drill.rst index 0d276425..92a3e023 100644 --- a/docs/source/configuration/outputs/gerb_drill.rst +++ b/docs/source/configuration/outputs/gerb_drill.rst @@ -53,7 +53,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Used for sub-PCBs. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'gerb_drill' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/gerber.rst b/docs/source/configuration/outputs/gerber.rst index e200928e..4b0aba6c 100644 --- a/docs/source/configuration/outputs/gerber.rst +++ b/docs/source/configuration/outputs/gerber.rst @@ -84,7 +84,7 @@ Parameters: - ``use_aux_axis_as_origin`` :index:`: ` [boolean=false] Use the auxiliary axis as origin for coordinates. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'gerber' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/hpgl.rst b/docs/source/configuration/outputs/hpgl.rst index 9397d9b5..bd379b5d 100644 --- a/docs/source/configuration/outputs/hpgl.rst +++ b/docs/source/configuration/outputs/hpgl.rst @@ -82,7 +82,7 @@ Parameters: - ``uppercase_extensions`` :index:`: ` [boolean=false] Use uppercase names for the extensions. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'hpgl' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/hpgl_sch_print.rst b/docs/source/configuration/outputs/hpgl_sch_print.rst index 5e852f6f..0543578c 100644 --- a/docs/source/configuration/outputs/hpgl_sch_print.rst +++ b/docs/source/configuration/outputs/hpgl_sch_print.rst @@ -44,7 +44,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Not fitted components are crossed. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'hpgl_sch_print' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/ibom.rst b/docs/source/configuration/outputs/ibom.rst index 3f88c48a..3caa3e7e 100644 --- a/docs/source/configuration/outputs/ibom.rst +++ b/docs/source/configuration/outputs/ibom.rst @@ -90,7 +90,7 @@ Parameters: - ``variants_whitelist`` :index:`: ` [string=''] List of board variants to include in the BOM. IBoM option, avoid using in conjunction with KiBot variants/filters. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'ibom' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/info.rst b/docs/source/configuration/outputs/info.rst index 97c89611..af632fb8 100644 --- a/docs/source/configuration/outputs/info.rst +++ b/docs/source/configuration/outputs/info.rst @@ -30,7 +30,7 @@ Parameters: - ``environment`` :index:`: ` [string='names'] [names,none,full] List environment variables. IMPORTANT: Don't use `full` unless you know you are not leaking sensitive information. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'info' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/kibom.rst b/docs/source/configuration/outputs/kibom.rst index 84886df9..f9972ec3 100644 --- a/docs/source/configuration/outputs/kibom.rst +++ b/docs/source/configuration/outputs/kibom.rst @@ -130,7 +130,7 @@ Parameters: variants with the ';' (semicolon) character. This isn't related to the KiBot concept of variants. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'kibom' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/kicost.rst b/docs/source/configuration/outputs/kicost.rst index 31f92f64..bdadd16c 100644 --- a/docs/source/configuration/outputs/kicost.rst +++ b/docs/source/configuration/outputs/kicost.rst @@ -73,7 +73,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Don't use the `kicost_variant` when using internal variants/filters. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'kicost' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/kikit_present.rst b/docs/source/configuration/outputs/kikit_present.rst index eac979cf..e246ff81 100644 --- a/docs/source/configuration/outputs/kikit_present.rst +++ b/docs/source/configuration/outputs/kikit_present.rst @@ -88,7 +88,7 @@ Parameters: - ``template`` :index:`: ` [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:`: ` [string=''] Type of output. +- **type** :index:`: ` 'kikit_present' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/kiri.rst b/docs/source/configuration/outputs/kiri.rst index 8032accf..03dfae6b 100644 --- a/docs/source/configuration/outputs/kiri.rst +++ b/docs/source/configuration/outputs/kiri.rst @@ -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:`: ` [string=''] Type of output. +- **type** :index:`: ` 'kiri' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/navigate_results.rst b/docs/source/configuration/outputs/navigate_results.rst index 0ce65047..ce2594fd 100644 --- a/docs/source/configuration/outputs/navigate_results.rst +++ b/docs/source/configuration/outputs/navigate_results.rst @@ -27,7 +27,7 @@ Parameters: - **output** :index:`: ` [string='%f-%i%I%v.%x'] Filename for the output (%i=html, %x=navigate). Affected by global options. - ``skip_not_run`` :index:`: ` [boolean=false] Skip outputs with `run_by_default: false`. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'navigate_results' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/netlist.rst b/docs/source/configuration/outputs/netlist.rst index 593f79b8..1bd59c9c 100644 --- a/docs/source/configuration/outputs/netlist.rst +++ b/docs/source/configuration/outputs/netlist.rst @@ -37,7 +37,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Used for sub-PCBs. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'netlist' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/panelize.rst b/docs/source/configuration/outputs/panelize.rst index 91b27873..863da06c 100644 --- a/docs/source/configuration/outputs/panelize.rst +++ b/docs/source/configuration/outputs/panelize.rst @@ -383,7 +383,7 @@ Parameters: - ``units`` :index:`: ` [string='mm'] [millimeters,inches,mils,mm,cm,dm,m,mil,inch,in] Units used when omitted. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'panelize' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/pcb2blender_tools.rst b/docs/source/configuration/outputs/pcb2blender_tools.rst index f1107bb9..7552b1b0 100644 --- a/docs/source/configuration/outputs/pcb2blender_tools.rst +++ b/docs/source/configuration/outputs/pcb2blender_tools.rst @@ -55,7 +55,7 @@ Parameters: - ``sub_boards_stacked_prefix`` :index:`: ` [string='stacked\_'] Prefix used for the stack files. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'pcb2blender_tools' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/pcb_print.rst b/docs/source/configuration/outputs/pcb_print.rst index fdfd7f15..16405d90 100644 --- a/docs/source/configuration/outputs/pcb_print.rst +++ b/docs/source/configuration/outputs/pcb_print.rst @@ -152,7 +152,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. - ``via_color`` :index:`: ` [string=''] Color used for through-hole `colored_vias`. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'pcb_print' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/pcb_variant.rst b/docs/source/configuration/outputs/pcb_variant.rst index 911be979..f18daae0 100644 --- a/docs/source/configuration/outputs/pcb_variant.rst +++ b/docs/source/configuration/outputs/pcb_variant.rst @@ -38,7 +38,7 @@ Parameters: If it starts with `+` the text is concatenated. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'pcb_variant' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/pcbdraw.rst b/docs/source/configuration/outputs/pcbdraw.rst index e52d5e75..fa6002aa 100644 --- a/docs/source/configuration/outputs/pcbdraw.rst +++ b/docs/source/configuration/outputs/pcbdraw.rst @@ -129,7 +129,7 @@ Parameters: Note that any other content from this layer will be included. - ``warnings`` :index:`: ` [string='visible'] [visible,all,none] Using visible only the warnings about components in the visible side are generated. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'pcbdraw' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/pdf.rst b/docs/source/configuration/outputs/pdf.rst index edee6293..cce47459 100644 --- a/docs/source/configuration/outputs/pdf.rst +++ b/docs/source/configuration/outputs/pdf.rst @@ -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:`: ` [number=1] Scale factor (0 means autoscaling). -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'pdf' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/pdf_pcb_print.rst b/docs/source/configuration/outputs/pdf_pcb_print.rst index 4dfa2f8c..4dcd8324 100644 --- a/docs/source/configuration/outputs/pdf_pcb_print.rst +++ b/docs/source/configuration/outputs/pdf_pcb_print.rst @@ -64,7 +64,7 @@ Parameters: If it starts with `+` the text is concatenated. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'pdf_pcb_print' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/pdf_sch_print.rst b/docs/source/configuration/outputs/pdf_sch_print.rst index 495506c2..578e45f6 100644 --- a/docs/source/configuration/outputs/pdf_sch_print.rst +++ b/docs/source/configuration/outputs/pdf_sch_print.rst @@ -43,7 +43,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Not fitted components are crossed. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'pdf_sch_print' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/pdfunite.rst b/docs/source/configuration/outputs/pdfunite.rst index 214ad673..9b0d2151 100644 --- a/docs/source/configuration/outputs/pdfunite.rst +++ b/docs/source/configuration/outputs/pdfunite.rst @@ -38,7 +38,7 @@ Parameters: - ``use_external_command`` :index:`: ` [boolean=false] Use the `pdfunite` tool instead of PyPDF2 Python module. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'pdfunite' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/populate.rst b/docs/source/configuration/outputs/populate.rst index e42b1bf4..f56b952c 100644 --- a/docs/source/configuration/outputs/populate.rst +++ b/docs/source/configuration/outputs/populate.rst @@ -49,7 +49,7 @@ Parameters: The `simple.handlebars` template is a built-in template. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'populate' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/position.rst b/docs/source/configuration/outputs/position.rst index e13499c0..7c41a97d 100644 --- a/docs/source/configuration/outputs/position.rst +++ b/docs/source/configuration/outputs/position.rst @@ -56,7 +56,7 @@ Parameters: Supported by the gerber format. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'position' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/ps.rst b/docs/source/configuration/outputs/ps.rst index 975525f6..f3048306 100644 --- a/docs/source/configuration/outputs/ps.rst +++ b/docs/source/configuration/outputs/ps.rst @@ -87,7 +87,7 @@ Parameters: - ``width_adjust`` :index:`: ` [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:`: ` [string=''] Type of output. +- **type** :index:`: ` 'ps' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/ps_sch_print.rst b/docs/source/configuration/outputs/ps_sch_print.rst index 3cee779c..3fe9dae8 100644 --- a/docs/source/configuration/outputs/ps_sch_print.rst +++ b/docs/source/configuration/outputs/ps_sch_print.rst @@ -42,7 +42,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Not fitted components are crossed. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'ps_sch_print' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/qr_lib.rst b/docs/source/configuration/outputs/qr_lib.rst index 98ef9ce8..2ea90668 100644 --- a/docs/source/configuration/outputs/qr_lib.rst +++ b/docs/source/configuration/outputs/qr_lib.rst @@ -48,7 +48,7 @@ Parameters: - ``reference`` :index:`: ` [string='QR'] The reference prefix. - ``use_sch_dir`` :index:`: ` [boolean=true] Generate the libs relative to the schematic/PCB dir. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'qr_lib' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/render_3d.rst b/docs/source/configuration/outputs/render_3d.rst index c1ce22ad..f4f06151 100644 --- a/docs/source/configuration/outputs/render_3d.rst +++ b/docs/source/configuration/outputs/render_3d.rst @@ -101,7 +101,7 @@ Parameters: In this case the value is interpreted as a time-out.. - ``width`` :index:`: ` [number=1280] Image width (aprox.). -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'render_3d' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/report.rst b/docs/source/configuration/outputs/report.rst index 57054b12..655f05d1 100644 --- a/docs/source/configuration/outputs/report.rst +++ b/docs/source/configuration/outputs/report.rst @@ -45,7 +45,7 @@ Parameters: diameter can be reduced to accommodate the correct annular ring values. Use 0 to disable it. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'report' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/sch_variant.rst b/docs/source/configuration/outputs/sch_variant.rst index e0fb08a8..dfcc40aa 100644 --- a/docs/source/configuration/outputs/sch_variant.rst +++ b/docs/source/configuration/outputs/sch_variant.rst @@ -36,7 +36,7 @@ Parameters: If it starts with `+` the text is concatenated. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'sch_variant' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/stencil_3d.rst b/docs/source/configuration/outputs/stencil_3d.rst index d2192bb6..718bda62 100644 --- a/docs/source/configuration/outputs/stencil_3d.rst +++ b/docs/source/configuration/outputs/stencil_3d.rst @@ -56,7 +56,7 @@ Parameters: side contains solder paste. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'stencil_3d' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/stencil_for_jig.rst b/docs/source/configuration/outputs/stencil_for_jig.rst index 53ed379f..a0120f5b 100644 --- a/docs/source/configuration/outputs/stencil_for_jig.rst +++ b/docs/source/configuration/outputs/stencil_for_jig.rst @@ -57,7 +57,7 @@ Parameters: - ``tolerance`` :index:`: ` [number=0.05] Enlarges the register by the tolerance value [mm]. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'stencil_for_jig' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/step.rst b/docs/source/configuration/outputs/step.rst index 5055b3d3..3d7f42a2 100644 --- a/docs/source/configuration/outputs/step.rst +++ b/docs/source/configuration/outputs/step.rst @@ -53,7 +53,7 @@ Parameters: - ``subst_models`` :index:`: ` [boolean=true] Substitute STEP or IGS models with the same name in place of VRML models. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'step' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/svg.rst b/docs/source/configuration/outputs/svg.rst index 3e8cfd41..7eb4612e 100644 --- a/docs/source/configuration/outputs/svg.rst +++ b/docs/source/configuration/outputs/svg.rst @@ -104,7 +104,7 @@ Parameters: - ``uppercase_extensions`` :index:`: ` [boolean=false] Use uppercase names for the extensions. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'svg' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/svg_pcb_print.rst b/docs/source/configuration/outputs/svg_pcb_print.rst index 5d2199e5..21a8e726 100644 --- a/docs/source/configuration/outputs/svg_pcb_print.rst +++ b/docs/source/configuration/outputs/svg_pcb_print.rst @@ -65,7 +65,7 @@ Parameters: If it starts with `+` the text is concatenated. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'svg_pcb_print' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/svg_sch_print.rst b/docs/source/configuration/outputs/svg_sch_print.rst index a4cd8697..c794825f 100644 --- a/docs/source/configuration/outputs/svg_sch_print.rst +++ b/docs/source/configuration/outputs/svg_sch_print.rst @@ -43,7 +43,7 @@ Parameters: - ``variant`` :index:`: ` [string=''] Board variant to apply. Not fitted components are crossed. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'svg_sch_print' - ``category`` :index:`: ` [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`. diff --git a/docs/source/configuration/outputs/vrml.rst b/docs/source/configuration/outputs/vrml.rst index b15d7dda..e794e4d2 100644 --- a/docs/source/configuration/outputs/vrml.rst +++ b/docs/source/configuration/outputs/vrml.rst @@ -65,7 +65,7 @@ Parameters: When disabled the `ref_x`, `ref_y` and `ref_units` will be used. - ``variant`` :index:`: ` [string=''] Board variant to apply. -- **type** :index:`: ` [string=''] Type of output. +- **type** :index:`: ` 'vrml' - ``category`` :index:`: ` [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`. diff --git a/kibot/config_reader.py b/kibot/config_reader.py index 70183950..380b127e 100644 --- a/kibot/config_reader.py +++ b/kibot/config_reader.py @@ -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:`: ` ' 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)*' '