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

[DOCs] Updated 

- Fixed spelling
- New command line option
- New error level
- KiDiff version needed
This commit is contained in:
Salvador E. Tropea 2024-01-05 10:52:03 -03:00
parent f4e6b421de
commit 14fb810c0f
7 changed files with 13 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -238,7 +238,7 @@ outputs:
texture_dpi: 1016.0 texture_dpi: 1016.0
# [dict|list(dict)] How the object is viewed by the camera # [dict|list(dict)] How the object is viewed by the camera
point_of_view: point_of_view:
# [string=''] String to diferentiate the name of this point of view. # [string=''] String to differentiate the name of this point of view.
# When empty we use the `default_file_id` or the `view` # When empty we use the `default_file_id` or the `view`
- file_id: '' - file_id: ''
# [number=0] Angle to rotate the board in the X axis, positive is clockwise [degrees] # [number=0] Angle to rotate the board in the X axis, positive is clockwise [degrees]
@ -764,7 +764,7 @@ outputs:
# symlink. Useful for some Windows setups # symlink. Useful for some Windows setups
copy_instead_of_link: false copy_instead_of_link: false
# [string='red_green'] [red_green,stats] In the `red_green` mode added stuff is green and red when removed. # [string='red_green'] [red_green,stats] In the `red_green` mode added stuff is green and red when removed.
# The `stats` mode is used to meassure the amount of difference. In this mode all # The `stats` mode is used to measure the amount of difference. In this mode all
# changes are red, but you can abort if the difference is bigger than certain threshold # changes are red, but you can abort if the difference is bigger than certain threshold
diff_mode: 'red_green' diff_mode: 'red_green'
# [string|list(string)='_none'] Name of the filter to mark components as not fitted. # [string|list(string)='_none'] Name of the filter to mark components as not fitted.
@ -803,7 +803,7 @@ outputs:
# Use `multivar` to specify a reference file when `new_type` is also `multivar` # Use `multivar` to specify a reference file when `new_type` is also `multivar`
old_type: 'git' old_type: 'git'
# [boolean=false] Only include the pages with differences in the output PDF. # [boolean=false] Only include the pages with differences in the output PDF.
# Note that when no differeces are found we get a page saying *No diff* # Note that when no differences are found we get a page saying *No diff*
only_different: false only_different: false
# [boolean=false] Compare only the main schematic page (root page) # [boolean=false] Compare only the main schematic page (root page)
only_first_sch_page: false only_first_sch_page: false
@ -2544,7 +2544,7 @@ outputs:
# `reference` is an alias for `ref` # `reference` is an alias for `ref`
# [string|list(string)=''] List of resistors to flip its bands # [string|list(string)=''] List of resistors to flip its bands
resistor_flip: '' resistor_flip: ''
# [list(dict)] List of resitors to be remapped. You can change the value of the resistors here # [list(dict)] List of resistors to be remapped. You can change the value of the resistors here
resistor_remap: resistor_remap:
# [string=''] Reference for the resistor to change # [string=''] Reference for the resistor to change
- ref: '' - ref: ''

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

@ -75,7 +75,7 @@ Parameters:
- **view** :index:`: <pair: output - blender_export - options - point_of_view; view>` [string='top'] [top,bottom,front,rear,right,left,z,Z,y,Y,x,X] Point of view. - **view** :index:`: <pair: output - blender_export - options - point_of_view; view>` [string='top'] [top,bottom,front,rear,right,left,z,Z,y,Y,x,X] Point of view.
Compatible with `render_3d`. Compatible with `render_3d`.
- ``file_id`` :index:`: <pair: output - blender_export - options - point_of_view; file_id>` [string=''] String to diferentiate the name of this point of view. - ``file_id`` :index:`: <pair: output - blender_export - options - point_of_view; file_id>` [string=''] String to differentiate the name of this point of view.
When empty we use the `default_file_id` or the `view`. When empty we use the `default_file_id` or the `view`.
- ``rotate_x`` :index:`: <pair: output - blender_export - options - point_of_view; rotate_x>` [number=0] Angle to rotate the board in the X axis, positive is clockwise [degrees]. - ``rotate_x`` :index:`: <pair: output - blender_export - options - point_of_view; rotate_x>` [number=0] Angle to rotate the board in the X axis, positive is clockwise [degrees].
- ``rotate_y`` :index:`: <pair: output - blender_export - options - point_of_view; rotate_y>` [number=0] Angle to rotate the board in the Y axis, positive is clockwise [degrees]. - ``rotate_y`` :index:`: <pair: output - blender_export - options - point_of_view; rotate_y>` [number=0] Angle to rotate the board in the Y axis, positive is clockwise [degrees].

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

@ -47,7 +47,7 @@ Parameters:
- ``copy_instead_of_link`` :index:`: <pair: output - diff - options; copy_instead_of_link>` [boolean=false] Modifies the behavior of `add_link_id` to create a copy of the file instead of a - ``copy_instead_of_link`` :index:`: <pair: output - diff - options; copy_instead_of_link>` [boolean=false] Modifies the behavior of `add_link_id` to create a copy of the file instead of a
symlink. Useful for some Windows setups. symlink. Useful for some Windows setups.
- ``diff_mode`` :index:`: <pair: output - diff - options; diff_mode>` [string='red_green'] [red_green,stats] In the `red_green` mode added stuff is green and red when removed. - ``diff_mode`` :index:`: <pair: output - diff - options; diff_mode>` [string='red_green'] [red_green,stats] In the `red_green` mode added stuff is green and red when removed.
The `stats` mode is used to meassure the amount of difference. In this mode all The `stats` mode is used to measure the amount of difference. In this mode all
changes are red, but you can abort if the difference is bigger than certain threshold. changes are red, but you can abort if the difference is bigger than certain threshold.
- ``dnf_filter`` :index:`: <pair: output - diff - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted. - ``dnf_filter`` :index:`: <pair: output - diff - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted.
A short-cut to use for simple cases where a variant is an overkill. A short-cut to use for simple cases where a variant is an overkill.
@ -79,7 +79,7 @@ Parameters:
Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output. Use `file` for a file name. Use `output` to specify the name of a `pcb_variant`/`sch_variant` output.
Use `multivar` to specify a reference file when `new_type` is also `multivar`. Use `multivar` to specify a reference file when `new_type` is also `multivar`.
- ``only_different`` :index:`: <pair: output - diff - options; only_different>` [boolean=false] Only include the pages with differences in the output PDF. - ``only_different`` :index:`: <pair: output - diff - options; only_different>` [boolean=false] Only include the pages with differences in the output PDF.
Note that when no differeces are found we get a page saying *No diff*. Note that when no differences are found we get a page saying *No diff*.
- ``only_first_sch_page`` :index:`: <pair: output - diff - options; only_first_sch_page>` [boolean=false] Compare only the main schematic page (root page). - ``only_first_sch_page`` :index:`: <pair: output - diff - options; only_first_sch_page>` [boolean=false] Compare only the main schematic page (root page).
- ``pcb`` :index:`: <pair: output - diff - options; pcb>` [boolean=true] Compare the PCB, otherwise compare the schematic. - ``pcb`` :index:`: <pair: output - diff - options; pcb>` [boolean=true] Compare the PCB, otherwise compare the schematic.
- ``pre_transform`` :index:`: <pair: output - diff - options; pre_transform>` [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. - ``pre_transform`` :index:`: <pair: output - diff - options; pre_transform>` [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.

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

@ -103,7 +103,7 @@ Parameters:
- ``resistor_flip`` :index:`: <pair: output - pcbdraw - options; resistor_flip>` [string|list(string)=''] List of resistors to flip its bands. - ``resistor_flip`` :index:`: <pair: output - pcbdraw - options; resistor_flip>` [string|list(string)=''] List of resistors to flip its bands.
- ``resistor_remap`` :index:`: <pair: output - pcbdraw - options; resistor_remap>` [list(dict)] List of resitors to be remapped. You can change the value of the resistors here. - ``resistor_remap`` :index:`: <pair: output - pcbdraw - options; resistor_remap>` [list(dict)] List of resistors to be remapped. You can change the value of the resistors here.
- Valid keys: - Valid keys:

2
docs/source/dependencies.rst
View File

@ -28,7 +28,7 @@
- Optional to separate multiboard projects for general use - Optional to separate multiboard projects for general use
- Note: Official 1.3.0 release does not work, use my fork if 1.3.0 is the latest - Note: Official 1.3.0 release does not work, use my fork if 1.3.0 is the latest
`KiCad PCB/SCH Diff <https://github.com/INTI-CMNB/KiDiff>`__ :index:`: <pair: dependency; KiCad PCB/SCH Diff>` v2.5.0 |image12| |Auto-download| `KiCad PCB/SCH Diff <https://github.com/INTI-CMNB/KiDiff>`__ :index:`: <pair: dependency; KiCad PCB/SCH Diff>` v2.5.1 |image12| |Auto-download|
- Mandatory for: `diff`, `kiri` - Mandatory for: `diff`, `kiri`

1
docs/source/errors.rst
View File

@ -39,3 +39,4 @@ Supported error levels
- 33: HPGL_SCH_PRINT - 33: HPGL_SCH_PRINT
- 34: CORRUPTED_PRO - 34: CORRUPTED_PRO
- 35: BLENDER_ERROR - 35: BLENDER_ERROR
- 36: WARN_AS_ERROR

5
docs/source/usage.txt
View File

@ -1,9 +1,9 @@
KiBot: KiCad automation tool for documents generation KiBot: KiCad automation tool for documents generation
Usage: Usage:
kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE] [-D] kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE]
[-q | -v...] [-L LOGFILE] [-C | -i | -n] [-m MKFILE] [-A] [-g DEF] ... [-q | -v...] [-L LOGFILE] [-C | -i | -n] [-m MKFILE] [-A] [-g DEF] ...
[-E DEF] ... [-w LIST] [--banner N] [TARGET...] [-E DEF] ... [-w LIST] [-D | -W] [--banner N] [TARGET...]
kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] [--banner N] kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] [--banner N]
[-E DEF] ... [--config-outs] [--only-pre|--only-groups] [--only-names] [-E DEF] ... [--config-outs] [--only-pre|--only-groups] [--only-names]
[--output-name-first] --list [--output-name-first] --list
@ -65,6 +65,7 @@ Options:
-v, --verbose Show debugging information -v, --verbose Show debugging information
-V, --version Show program's version number and exit -V, --version Show program's version number and exit
-w, --no-warn LIST Exclude the mentioned warnings (comma sep) -w, --no-warn LIST Exclude the mentioned warnings (comma sep)
-W, --stop-on-warnings Stop on warnings
-x, --example Create a template configuration file -x, --example Create a template configuration file
Quick start options: Quick start options: