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

Merge pull request #569 from edlongman/remove-tex-instances 

Add backticks around custom_reports docs to improve layout
This commit is contained in:
Salvador E. Tropea 2024-01-25 07:16:15 -03:00 committed by GitHub
parent 2ff4035c94 c5d6953972
commit 2889f25ad7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 28 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -872,8 +872,8 @@ outputs:
options: options:
# [list(dict)] A list of customized reports for the manufacturer # [list(dict)] A list of customized reports for the manufacturer
custom_reports: custom_reports:
# [string=''] Content for the report. Use `${basename}` for the project name without extension. # [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
# Use `${filename(LAYER)}` for the file corresponding to LAYER # Use ``${filename(LAYER)}`` for the file corresponding to LAYER
- content: '' - content: ''
# [string='Custom_report.txt'] File name for the custom report # [string='Custom_report.txt'] File name for the custom report
output: 'Custom_report.txt' output: 'Custom_report.txt'
@ -1100,8 +1100,8 @@ outputs:
create_gerber_job_file: true create_gerber_job_file: true
# [list(dict)] A list of customized reports for the manufacturer # [list(dict)] A list of customized reports for the manufacturer
custom_reports: custom_reports:
# [string=''] Content for the report. Use `${basename}` for the project name without extension. # [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
# Use `${filename(LAYER)}` for the file corresponding to LAYER # Use ``${filename(LAYER)}`` for the file corresponding to LAYER
- content: '' - content: ''
# [string='Custom_report.txt'] File name for the custom report # [string='Custom_report.txt'] File name for the custom report
output: 'Custom_report.txt' output: 'Custom_report.txt'
@ -1176,8 +1176,8 @@ outputs:
options: options:
# [list(dict)] A list of customized reports for the manufacturer # [list(dict)] A list of customized reports for the manufacturer
custom_reports: custom_reports:
# [string=''] Content for the report. Use `${basename}` for the project name without extension. # [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
# Use `${filename(LAYER)}` for the file corresponding to LAYER # Use ``${filename(LAYER)}`` for the file corresponding to LAYER
- content: '' - content: ''
# [string='Custom_report.txt'] File name for the custom report # [string='Custom_report.txt'] File name for the custom report
output: 'Custom_report.txt' output: 'Custom_report.txt'
@ -2626,8 +2626,8 @@ outputs:
options: options:
# [list(dict)] A list of customized reports for the manufacturer # [list(dict)] A list of customized reports for the manufacturer
custom_reports: custom_reports:
# [string=''] Content for the report. Use `${basename}` for the project name without extension. # [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
# Use `${filename(LAYER)}` for the file corresponding to LAYER # Use ``${filename(LAYER)}`` for the file corresponding to LAYER
- content: '' - content: ''
# [string='Custom_report.txt'] File name for the custom report # [string='Custom_report.txt'] File name for the custom report
output: 'Custom_report.txt' output: 'Custom_report.txt'
@ -2891,8 +2891,8 @@ outputs:
a4_output: true a4_output: true
# [list(dict)] A list of customized reports for the manufacturer # [list(dict)] A list of customized reports for the manufacturer
custom_reports: custom_reports:
# [string=''] Content for the report. Use `${basename}` for the project name without extension. # [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
# Use `${filename(LAYER)}` for the file corresponding to LAYER # Use ``${filename(LAYER)}`` for the file corresponding to LAYER
- content: '' - content: ''
# [string='Custom_report.txt'] File name for the custom report # [string='Custom_report.txt'] File name for the custom report
output: 'Custom_report.txt' output: 'Custom_report.txt'
@ -3375,8 +3375,8 @@ outputs:
options: options:
# [list(dict)] A list of customized reports for the manufacturer # [list(dict)] A list of customized reports for the manufacturer
custom_reports: custom_reports:
# [string=''] Content for the report. Use `${basename}` for the project name without extension. # [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
# Use `${filename(LAYER)}` for the file corresponding to LAYER # Use ``${filename(LAYER)}`` for the file corresponding to LAYER
- content: '' - content: ''
# [string='Custom_report.txt'] File name for the custom report # [string='Custom_report.txt'] File name for the custom report
output: 'Custom_report.txt' output: 'Custom_report.txt'

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

@ -48,8 +48,8 @@ Parameters:
- Valid keys: - Valid keys:
- ``content`` :index:`: <pair: output - dxf - options - custom_reports; content>` [string=''] Content for the report. Use `${basename}` for the project name without extension. - ``content`` :index:`: <pair: output - dxf - options - custom_reports; content>` [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
Use `${filename(LAYER)}` for the file corresponding to LAYER. Use ``${filename(LAYER)}`` for the file corresponding to LAYER.
- ``output`` :index:`: <pair: output - dxf - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report. - ``output`` :index:`: <pair: output - dxf - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report.
- ``dnf_filter`` :index:`: <pair: output - dxf - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted. - ``dnf_filter`` :index:`: <pair: output - dxf - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted.

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

@ -53,8 +53,8 @@ Parameters:
- Valid keys: - Valid keys:
- ``content`` :index:`: <pair: output - gerber - options - custom_reports; content>` [string=''] Content for the report. Use `${basename}` for the project name without extension. - ``content`` :index:`: <pair: output - gerber - options - custom_reports; content>` [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
Use `${filename(LAYER)}` for the file corresponding to LAYER. Use ``${filename(LAYER)}`` for the file corresponding to LAYER.
- ``output`` :index:`: <pair: output - gerber - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report. - ``output`` :index:`: <pair: output - gerber - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report.
- ``disable_aperture_macros`` :index:`: <pair: output - gerber - options; disable_aperture_macros>` [boolean=false] Disable aperture macros (workaround for buggy CAM software) (KiCad 6). - ``disable_aperture_macros`` :index:`: <pair: output - gerber - options; disable_aperture_macros>` [boolean=false] Disable aperture macros (workaround for buggy CAM software) (KiCad 6).

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

@ -47,8 +47,8 @@ Parameters:
- Valid keys: - Valid keys:
- ``content`` :index:`: <pair: output - hpgl - options - custom_reports; content>` [string=''] Content for the report. Use `${basename}` for the project name without extension. - ``content`` :index:`: <pair: output - hpgl - options - custom_reports; content>` [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
Use `${filename(LAYER)}` for the file corresponding to LAYER. Use ``${filename(LAYER)}`` for the file corresponding to LAYER.
- ``output`` :index:`: <pair: output - hpgl - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report. - ``output`` :index:`: <pair: output - hpgl - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report.
- ``dnf_filter`` :index:`: <pair: output - hpgl - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted. - ``dnf_filter`` :index:`: <pair: output - hpgl - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted.

8
docs/source/configuration/outputs/pdf.rst
View File

@ -50,8 +50,8 @@ Parameters:
- Valid keys: - Valid keys:
- ``content`` :index:`: <pair: output - pdf - options - custom_reports; content>` [string=''] Content for the report. Use `${basename}` for the project name without extension. - ``content`` :index:`: <pair: output - pdf - options - custom_reports; content>` [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
Use `${filename(LAYER)}` for the file corresponding to LAYER. Use ``${filename(LAYER)}`` for the file corresponding to LAYER.
- ``output`` :index:`: <pair: output - pdf - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report. - ``output`` :index:`: <pair: output - pdf - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report.
- ``dnf_filter`` :index:`: <pair: output - pdf - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted. - ``dnf_filter`` :index:`: <pair: output - pdf - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted.
@ -99,8 +99,8 @@ Parameters:
- Valid keys: - Valid keys:
- ``content`` :index:`: <pair: output - pdf - custom_reports; content>` [string=''] Content for the report. Use `${basename}` for the project name without extension. - ``content`` :index:`: <pair: output - pdf - custom_reports; content>` [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
Use `${filename(LAYER)}` for the file corresponding to LAYER. Use ``${filename(LAYER)}`` for the file corresponding to LAYER.
- ``output`` :index:`: <pair: output - pdf - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report. - ``output`` :index:`: <pair: output - pdf - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report.
- ``disable_run_by_default`` :index:`: <pair: output - pdf; disable_run_by_default>` [string|boolean] Use it to disable the `run_by_default` status of other output. - ``disable_run_by_default`` :index:`: <pair: output - pdf; disable_run_by_default>` [string|boolean] Use it to disable the `run_by_default` status of other output.

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

@ -50,8 +50,8 @@ Parameters:
- Valid keys: - Valid keys:
- ``content`` :index:`: <pair: output - ps - options - custom_reports; content>` [string=''] Content for the report. Use `${basename}` for the project name without extension. - ``content`` :index:`: <pair: output - ps - options - custom_reports; content>` [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
Use `${filename(LAYER)}` for the file corresponding to LAYER. Use ``${filename(LAYER)}`` for the file corresponding to LAYER.
- ``output`` :index:`: <pair: output - ps - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report. - ``output`` :index:`: <pair: output - ps - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report.
- ``dnf_filter`` :index:`: <pair: output - ps - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted. - ``dnf_filter`` :index:`: <pair: output - ps - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted.

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

@ -50,8 +50,8 @@ Parameters:
- Valid keys: - Valid keys:
- ``content`` :index:`: <pair: output - svg - options - custom_reports; content>` [string=''] Content for the report. Use `${basename}` for the project name without extension. - ``content`` :index:`: <pair: output - svg - options - custom_reports; content>` [string=''] Content for the report. Use ``${basename}`` for the project name without extension.
Use `${filename(LAYER)}` for the file corresponding to LAYER. Use ``${filename(LAYER)}`` for the file corresponding to LAYER.
- ``output`` :index:`: <pair: output - svg - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report. - ``output`` :index:`: <pair: output - svg - options - custom_reports; output>` [string='Custom_report.txt'] File name for the custom report.
- ``dnf_filter`` :index:`: <pair: output - svg - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted. - ``dnf_filter`` :index:`: <pair: output - svg - options; dnf_filter>` [string|list(string)='_none'] Name of the filter to mark components as not fitted.

4
kibot/out_any_layer.py
View File

@ -36,8 +36,8 @@ class CustomReport(Optionable):
self.output = 'Custom_report.txt' self.output = 'Custom_report.txt'
""" File name for the custom report """ """ File name for the custom report """
self.content = '' self.content = ''
""" Content for the report. Use `${basename}` for the project name without extension. """ Content for the report. Use ``${basename}`` for the project name without extension.
Use `${filename(LAYER)}` for the file corresponding to LAYER """ Use ``${filename(LAYER)}`` for the file corresponding to LAYER """
class AnyLayerOptions(VariantOptions): class AnyLayerOptions(VariantOptions):