diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 8b2d5c07..f1bf26f5 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -872,8 +872,8 @@ outputs: options: # [list(dict)] A list of customized reports for the manufacturer custom_reports: - # [string=''] Content for the report. Use `${basename}` for the project name without extension. - # Use `${filename(LAYER)}` for the file corresponding to LAYER + # [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + # Use ``${filename(LAYER)}`` for the file corresponding to LAYER - content: '' # [string='Custom_report.txt'] File name for the custom report output: 'Custom_report.txt' @@ -1100,8 +1100,8 @@ outputs: create_gerber_job_file: true # [list(dict)] A list of customized reports for the manufacturer custom_reports: - # [string=''] Content for the report. Use `${basename}` for the project name without extension. - # Use `${filename(LAYER)}` for the file corresponding to LAYER + # [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + # Use ``${filename(LAYER)}`` for the file corresponding to LAYER - content: '' # [string='Custom_report.txt'] File name for the custom report output: 'Custom_report.txt' @@ -1176,8 +1176,8 @@ outputs: options: # [list(dict)] A list of customized reports for the manufacturer custom_reports: - # [string=''] Content for the report. Use `${basename}` for the project name without extension. - # Use `${filename(LAYER)}` for the file corresponding to LAYER + # [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + # Use ``${filename(LAYER)}`` for the file corresponding to LAYER - content: '' # [string='Custom_report.txt'] File name for the custom report output: 'Custom_report.txt' @@ -2626,8 +2626,8 @@ outputs: options: # [list(dict)] A list of customized reports for the manufacturer custom_reports: - # [string=''] Content for the report. Use `${basename}` for the project name without extension. - # Use `${filename(LAYER)}` for the file corresponding to LAYER + # [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + # Use ``${filename(LAYER)}`` for the file corresponding to LAYER - content: '' # [string='Custom_report.txt'] File name for the custom report output: 'Custom_report.txt' @@ -2891,8 +2891,8 @@ outputs: a4_output: true # [list(dict)] A list of customized reports for the manufacturer custom_reports: - # [string=''] Content for the report. Use `${basename}` for the project name without extension. - # Use `${filename(LAYER)}` for the file corresponding to LAYER + # [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + # Use ``${filename(LAYER)}`` for the file corresponding to LAYER - content: '' # [string='Custom_report.txt'] File name for the custom report output: 'Custom_report.txt' @@ -3375,8 +3375,8 @@ outputs: options: # [list(dict)] A list of customized reports for the manufacturer custom_reports: - # [string=''] Content for the report. Use `${basename}` for the project name without extension. - # Use `${filename(LAYER)}` for the file corresponding to LAYER + # [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + # Use ``${filename(LAYER)}`` for the file corresponding to LAYER - content: '' # [string='Custom_report.txt'] File name for the custom report output: 'Custom_report.txt' diff --git a/docs/source/configuration/outputs/dxf.rst b/docs/source/configuration/outputs/dxf.rst index 4160c5b2..4a2edb8b 100644 --- a/docs/source/configuration/outputs/dxf.rst +++ b/docs/source/configuration/outputs/dxf.rst @@ -48,8 +48,8 @@ Parameters: - Valid keys: - - ``content`` :index:`: ` [string=''] Content for the report. Use `${basename}` for the project name without extension. - Use `${filename(LAYER)}` for the file corresponding to LAYER. + - ``content`` :index:`: ` [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + Use ``${filename(LAYER)}`` for the file corresponding to LAYER. - ``output`` :index:`: ` [string='Custom_report.txt'] File name for the custom report. - ``dnf_filter`` :index:`: ` [string|list(string)='_none'] Name of the filter to mark components as not fitted. diff --git a/docs/source/configuration/outputs/gerber.rst b/docs/source/configuration/outputs/gerber.rst index 92dc2fb0..19463ade 100644 --- a/docs/source/configuration/outputs/gerber.rst +++ b/docs/source/configuration/outputs/gerber.rst @@ -53,8 +53,8 @@ Parameters: - Valid keys: - - ``content`` :index:`: ` [string=''] Content for the report. Use `${basename}` for the project name without extension. - Use `${filename(LAYER)}` for the file corresponding to LAYER. + - ``content`` :index:`: ` [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + Use ``${filename(LAYER)}`` for the file corresponding to LAYER. - ``output`` :index:`: ` [string='Custom_report.txt'] File name for the custom report. - ``disable_aperture_macros`` :index:`: ` [boolean=false] Disable aperture macros (workaround for buggy CAM software) (KiCad 6). diff --git a/docs/source/configuration/outputs/hpgl.rst b/docs/source/configuration/outputs/hpgl.rst index ca2b754a..40fea85a 100644 --- a/docs/source/configuration/outputs/hpgl.rst +++ b/docs/source/configuration/outputs/hpgl.rst @@ -47,8 +47,8 @@ Parameters: - Valid keys: - - ``content`` :index:`: ` [string=''] Content for the report. Use `${basename}` for the project name without extension. - Use `${filename(LAYER)}` for the file corresponding to LAYER. + - ``content`` :index:`: ` [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + Use ``${filename(LAYER)}`` for the file corresponding to LAYER. - ``output`` :index:`: ` [string='Custom_report.txt'] File name for the custom report. - ``dnf_filter`` :index:`: ` [string|list(string)='_none'] Name of the filter to mark components as not fitted. diff --git a/docs/source/configuration/outputs/pdf.rst b/docs/source/configuration/outputs/pdf.rst index 4a1cf22b..a077438a 100644 --- a/docs/source/configuration/outputs/pdf.rst +++ b/docs/source/configuration/outputs/pdf.rst @@ -50,8 +50,8 @@ Parameters: - Valid keys: - - ``content`` :index:`: ` [string=''] Content for the report. Use `${basename}` for the project name without extension. - Use `${filename(LAYER)}` for the file corresponding to LAYER. + - ``content`` :index:`: ` [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + Use ``${filename(LAYER)}`` for the file corresponding to LAYER. - ``output`` :index:`: ` [string='Custom_report.txt'] File name for the custom report. - ``dnf_filter`` :index:`: ` [string|list(string)='_none'] Name of the filter to mark components as not fitted. @@ -99,8 +99,8 @@ Parameters: - Valid keys: - - ``content`` :index:`: ` [string=''] Content for the report. Use `${basename}` for the project name without extension. - Use `${filename(LAYER)}` for the file corresponding to LAYER. + - ``content`` :index:`: ` [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + Use ``${filename(LAYER)}`` for the file corresponding to LAYER. - ``output`` :index:`: ` [string='Custom_report.txt'] File name for the custom report. - ``disable_run_by_default`` :index:`: ` [string|boolean] Use it to disable the `run_by_default` status of other output. diff --git a/docs/source/configuration/outputs/ps.rst b/docs/source/configuration/outputs/ps.rst index 26962803..186edf87 100644 --- a/docs/source/configuration/outputs/ps.rst +++ b/docs/source/configuration/outputs/ps.rst @@ -50,8 +50,8 @@ Parameters: - Valid keys: - - ``content`` :index:`: ` [string=''] Content for the report. Use `${basename}` for the project name without extension. - Use `${filename(LAYER)}` for the file corresponding to LAYER. + - ``content`` :index:`: ` [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + Use ``${filename(LAYER)}`` for the file corresponding to LAYER. - ``output`` :index:`: ` [string='Custom_report.txt'] File name for the custom report. - ``dnf_filter`` :index:`: ` [string|list(string)='_none'] Name of the filter to mark components as not fitted. diff --git a/docs/source/configuration/outputs/svg.rst b/docs/source/configuration/outputs/svg.rst index 38b05ab8..33bb80e0 100644 --- a/docs/source/configuration/outputs/svg.rst +++ b/docs/source/configuration/outputs/svg.rst @@ -50,8 +50,8 @@ Parameters: - Valid keys: - - ``content`` :index:`: ` [string=''] Content for the report. Use `${basename}` for the project name without extension. - Use `${filename(LAYER)}` for the file corresponding to LAYER. + - ``content`` :index:`: ` [string=''] Content for the report. Use ``${basename}`` for the project name without extension. + Use ``${filename(LAYER)}`` for the file corresponding to LAYER. - ``output`` :index:`: ` [string='Custom_report.txt'] File name for the custom report. - ``dnf_filter`` :index:`: ` [string|list(string)='_none'] Name of the filter to mark components as not fitted. diff --git a/kibot/out_any_layer.py b/kibot/out_any_layer.py index 9165a2b9..ee2b02b0 100644 --- a/kibot/out_any_layer.py +++ b/kibot/out_any_layer.py @@ -36,8 +36,8 @@ class CustomReport(Optionable): self.output = 'Custom_report.txt' """ File name for the custom report """ self.content = '' - """ Content for the report. Use `${basename}` for the project name without extension. - Use `${filename(LAYER)}` for the file corresponding to LAYER """ + """ Content for the report. Use ``${basename}`` for the project name without extension. + Use ``${filename(LAYER)}`` for the file corresponding to LAYER """ class AnyLayerOptions(VariantOptions):