67 lines
4.8 KiB
ReStructuredText
67 lines
4.8 KiB
ReStructuredText
.. Automatically generated by KiBot, please don't edit this file
|
|
|
|
.. index::
|
|
pair: Design report; report
|
|
|
|
Design report
|
|
~~~~~~~~~~~~~
|
|
|
|
Generates a report about the design.
|
|
Mainly oriented to be sent to the manufacturer or check PCB details. |br|
|
|
You can expand internal values, KiCad text variables and environment
|
|
variables using `${VARIABLE}`
|
|
|
|
Type: ``report``
|
|
|
|
Category: **PCB/docs**
|
|
|
|
Parameters:
|
|
|
|
- **comment** :index:`: <pair: output - report; comment>` [string=''] A comment for documentation purposes. It helps to identify the output.
|
|
- **dir** :index:`: <pair: output - report; dir>` [string='./'] Output directory for the generated files.
|
|
If it starts with `+` the rest is concatenated to the default dir.
|
|
- **name** :index:`: <pair: output - report; name>` [string=''] Used to identify this particular output definition.
|
|
Avoid using `_` as first character. These names are reserved for KiBot.
|
|
- **options** :index:`: <pair: output - report; options>` [dict] Options for the `report` output.
|
|
|
|
- Valid keys:
|
|
|
|
- **convert_to** :index:`: <pair: output - report - options; convert_to>` [string='pdf'] Target format for the report conversion. See `do_convert`.
|
|
- **do_convert** :index:`: <pair: output - report - options; do_convert>` [boolean=false] Run `Pandoc` to convert the report. Note that Pandoc must be installed.
|
|
The conversion is done assuming the report is in `convert_from` format.
|
|
The output file will be in `convert_to` format.
|
|
The available formats depends on the `Pandoc` installation.
|
|
In CI/CD environments: the `kicad_auto_test` docker image contains it.
|
|
In Debian/Ubuntu environments: install `pandoc`, `texlive`, `texlive-latex-base` and `texlive-latex-recommended`.
|
|
- **output** :index:`: <pair: output - report - options; output>` [string='%f-%i%I%v.%x'] Output file name (%i='report', %x='txt'). Affected by global options.
|
|
- **template** :index:`: <pair: output - report - options; template>` [string='full'] Name for one of the internal templates (full, full_svg, simple) or a custom template file.
|
|
Environment variables and ~ are allowed.
|
|
Note: when converting to PDF PanDoc can fail on some Unicode values (use `simple_ASCII`).
|
|
- ``convert_from`` :index:`: <pair: output - report - options; convert_from>` [string='markdown'] Original format for the report conversion. Current templates are `markdown`. See `do_convert`.
|
|
- ``converted_output`` :index:`: <pair: output - report - options; converted_output>` [string='%f-%i%I%v.%x'] Converted output file name (%i='report', %x=`convert_to`).
|
|
Note that the extension should match the `convert_to` value. Affected by global options.
|
|
- ``eurocircuits_class_target`` :index:`: <pair: output - report - options; eurocircuits_class_target>` [string='10F'] Which Eurocircuits class are we aiming at.
|
|
- ``eurocircuits_reduce_holes`` :index:`: <pair: output - report - options; eurocircuits_reduce_holes>` [number=0.45] When computing the Eurocircuits category: Final holes sizes smaller or equal to this given
|
|
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.
|
|
- ``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`.
|
|
|
|
- ``disable_run_by_default`` :index:`: <pair: output - report; disable_run_by_default>` [string|boolean] 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`` :index:`: <pair: output - report; extends>` [string=''] Copy the `options` section from the indicated output.
|
|
Used to inherit options from another output of the same type.
|
|
- ``groups`` :index:`: <pair: output - report; groups>` [string|list(string)=''] 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`` :index:`: <pair: output - report; output_id>` [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
|
|
- ``priority`` :index:`: <pair: output - report; priority>` [number=50] [0,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`` :index:`: <pair: output - report; run_by_default>` [boolean=true] When enabled this output will be created when no specific outputs are requested.
|
|
|