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

INTI-CMNB · Jan 5, 2024 · e9733d9 · e9733d9
1 parent 14fb810
commit e9733d9
Show file tree

Hide file tree

Showing 48 changed files with 56 additions and 51 deletions.
diff --git a/docs/source/configuration/outputs/blender_export.rst b/docs/source/configuration/outputs/blender_export.rst
@@ -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`.

diff --git a/docs/source/configuration/outputs/boardview.rst b/docs/source/configuration/outputs/boardview.rst
@@ -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`.

diff --git a/docs/source/configuration/outputs/bom.rst b/docs/source/configuration/outputs/bom.rst
@@ -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`.

diff --git a/docs/source/configuration/outputs/compress.rst b/docs/source/configuration/outputs/compress.rst
@@ -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`.

diff --git a/docs/source/configuration/outputs/copy_files.rst b/docs/source/configuration/outputs/copy_files.rst
@@ -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`.

diff --git 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:`: <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`.

diff --git 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:`: <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`.

diff --git 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:`: <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`.

diff --git 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:`: <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`.

diff --git 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:`: <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`.

diff --git a/docs/source/configuration/outputs/gencad.rst b/docs/source/configuration/outputs/gencad.rst
@@ -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`.

diff --git a/docs/source/configuration/outputs/gerb_drill.rst b/docs/source/configuration/outputs/gerb_drill.rst
@@ -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`.

diff --git 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:`: <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`.

diff --git a/docs/source/configuration/outputs/hpgl.rst b/docs/source/configuration/outputs/hpgl.rst
@@ -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`.

diff --git 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:`: <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`.

diff --git a/docs/source/configuration/outputs/ibom.rst b/docs/source/configuration/outputs/ibom.rst
@@ -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`.

diff --git a/docs/source/configuration/outputs/info.rst b/docs/source/configuration/outputs/info.rst
@@ -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`.

diff --git 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:`: <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`.

diff --git a/docs/source/configuration/outputs/kicost.rst b/docs/source/configuration/outputs/kicost.rst
@@ -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`.

diff --git a/docs/source/configuration/outputs/kikit_present.rst b/docs/source/configuration/outputs/kikit_present.rst
@@ -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`.

diff --git 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:`: <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`.

diff --git a/docs/source/configuration/outputs/navigate_results.rst b/docs/source/configuration/outputs/navigate_results.rst
@@ -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`.

diff --git a/docs/source/configuration/outputs/netlist.rst b/docs/source/configuration/outputs/netlist.rst
@@ -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`.

diff --git a/docs/source/configuration/outputs/panelize.rst b/docs/source/configuration/outputs/panelize.rst
@@ -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`.

diff --git 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:`: <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`.

diff --git a/docs/source/configuration/outputs/pcb_print.rst b/docs/source/configuration/outputs/pcb_print.rst
@@ -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`.

diff --git 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:`: <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`.

diff --git 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:`: <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`.