KiRi
Generates an interactive web page to browse the schematic and/or PCB differences between git commits.
Must be applied to a git repository.
Recursive git submodules aren’t supported (submodules inside submodules).
Note that most browsers won’t allow Java Script to read local files,
needed to load the SCH/PCB. So you must use a web server or enable the
access to local files. In the case of Google Chrome you can use the
–allow-file-access-from-files command line option.
This output generates a simple Python web server called kiri-server that you can use.
For more information visit the KiRi web
Type: kiri
Categories: PCB/docs, Schematic/docs
Parameters:
comment : [string] (default:
'') A comment for documentation purposes. It helps to identify the output.dir : [string] (default:
'./') Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.layers : [Layer parameters] [list(dict) | list(string) | string] (default:
'all') (choices: “all”, “selected”, “copper”, “technical”, “user”, “inners”, “outers”) (also accepts any string) List of PCB layers to use. When empty all available layers are used.
Note that if you want to support adding/removing layers you should specify a list here.name : [string] (default:
'') Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.options : [KiRiOptions parameters] [dict] (default: empty dict, default values used) Options for the diff output.
type : ‘kiri’
category: [string | list(string)] (default:'') [comma separated] 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.
Using ‘.’ or ‘./’ as a category puts the file at the root.
The categories are currently used for navigate_results and navigate_results_rb.disable_run_by_default: [string | boolean] (default:'') Use it to disable the run_by_default status of other output. Useful when this output extends another and you don’t want to generate the original.
Use the boolean true value to disable the output you are extending.extends: [string] (default:'') Copy the options section from the indicated output. Used to inherit options from another output of the same type.groups: [string | list(string)] (default:'') One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.output_id: [string] (default:'') Text to use for the %I expansion content. To differentiate variations of this output.priority: [number] (default:50) (range: 0 to 100) Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.run_by_default: [boolean] (default:true) When enabled this output will be created when no specific outputs are requested.