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

[DOCs][Added] backticks to text replacement variables 

This is based on the #517 PR, but applied to the source code
This commit is contained in:
Salvador E. Tropea 2023-11-15 13:39:54 -03:00
parent d06dbbdf78
commit 45c5d2c7eb
14 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -31,7 +31,7 @@ Parameters:
- ``link_repeated`` :index:`: <pair: output - download_datasheets - options; link_repeated>` [boolean=true] Instead of download things we already downloaded use symlinks.
- ``output`` :index:`: <pair: output - download_datasheets - options; output>` [string='${VALUE}.pdf'] Name used for the downloaded datasheet.
${FIELD} will be replaced by the FIELD content.
`${FIELD}` will be replaced by the FIELD content.
- ``pre_transform`` :index:`: <pair: output - download_datasheets - options; pre_transform>` [string|list(string)='_none'] Name of the filter to transform fields before applying other filters.
A short-cut to use for simple cases where a variant is an overkill.

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

@ -48,8 +48,8 @@ Parameters:
- Valid keys:
- ``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.
- ``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.
- ``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.

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

@ -53,8 +53,8 @@ Parameters:
- Valid keys:
- ``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.
- ``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.
- ``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).

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

@ -47,8 +47,8 @@ Parameters:
- Valid keys:
- ``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.
- ``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.
- ``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.

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

@ -253,7 +253,7 @@ Parameters:
- Valid keys:
- **type** :index:`: <pair: output - panelize - options - configs - source; type>` [string='auto'] [auto,rectangle,annotation] How we select the area of the PCB tu used for the panelization.
- **type** :index:`: <pair: output - panelize - options - configs - source; type>` [string='auto'] [auto,rectangle,annotation] How we select the area of the PCB used for the panelization.
*auto* uses all the area reported by KiCad, *rectangle* a specified rectangle and
*annotation* selects a contour marked by a kikit:Board footprint.
- ``brx`` :index:`: <pair: output - panelize - options - configs - source; brx>` [number|string] Bottom right X coordinate of the rectangle used. Used for *rectangle*.

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

@ -50,8 +50,8 @@ Parameters:
- Valid keys:
- ``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.
- ``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.
- ``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.
@ -99,8 +99,8 @@ Parameters:
- Valid keys:
- ``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.
- ``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.
- ``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.

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

@ -50,8 +50,8 @@ Parameters:
- Valid keys:
- ``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.
- ``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.
- ``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.

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

@ -50,8 +50,8 @@ Parameters:
- Valid keys:
- ``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.
- ``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.
- ``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.

4
docs/source/configuration/sup_globals.rst
View File

@ -58,7 +58,7 @@
- ``environment`` :index:`: <pair: global options; environment>` [dict] Used to define environment variables used by KiCad.
The values defined here are exported as environment variables and has
more precedence than KiCad paths defined in the GUI.
You can make reference to any OS environment variable using ${VARIABLE}.
You can make reference to any OS environment variable using `${VARIABLE}`.
The KIPRJMOD is also available for expansion.
- Valid keys:
@ -193,6 +193,6 @@
- ``units`` :index:`: <pair: global options; units>` [string=''] [millimeters,inches,mils] Default units. Affects `position`, `bom` and `panelize` outputs.
Also KiCad 6 dimensions.
- ``use_dir_for_preflights`` :index:`: <pair: global options; use_dir_for_preflights>` [boolean=true] Use the global `dir` as subdir for the preflights.
- ``use_os_env_for_expand`` :index:`: <pair: global options; use_os_env_for_expand>` [boolean=true] In addition to KiCad text variables also use the OS environment variables when expanding ${VARIABLE}.
- ``use_os_env_for_expand`` :index:`: <pair: global options; use_os_env_for_expand>` [boolean=true] In addition to KiCad text variables also use the OS environment variables when expanding `${VARIABLE}`.
- ``variant`` :index:`: <pair: global options; variant>` [string=''] Default variant to apply to all outputs.

2
docs/source/configuration/sup_preflights.rst
View File

@ -116,7 +116,7 @@ Supported preflights
- **set_text_variables**: :index:`: <pair: preflights; set_text_variables>` [dict|list(dict)] Defines KiCad 6+ variables.
They are expanded using ${VARIABLE}, and stored in the project file. |br|
They are expanded using `${VARIABLE}`, and stored in the project file. |br|
This preflight replaces `pcb_replace` and `sch_replace` when using KiCad 6. |br|
The KiCad project file is modified. |br|

4
kibot/globals.py
View File

@ -282,7 +282,7 @@ class Globals(FiltersOptions):
""" [dict] Used to define environment variables used by KiCad.
The values defined here are exported as environment variables and has
more precedence than KiCad paths defined in the GUI.
You can make reference to any OS environment variable using ${VARIABLE}.
You can make reference to any OS environment variable using `${VARIABLE}`.
The KIPRJMOD is also available for expansion """
self.field_lcsc_part = ''
""" The name of the schematic field that contains the part number for the LCSC/JLCPCB distributor.
@ -324,7 +324,7 @@ class Globals(FiltersOptions):
Also note that the fonts are installed using a mechanism known to work on Debian,
which is used by the KiBot docker images, on other OSs *your mileage may vary* """
self.use_os_env_for_expand = True
""" In addition to KiCad text variables also use the OS environment variables when expanding ${VARIABLE} """
""" In addition to KiCad text variables also use the OS environment variables when expanding `${VARIABLE}` """
self.field_voltage = Optionable
""" [string|list(string)] Name/s of the field/s used for the voltage raiting.
Used for the value split filter.

4
kibot/out_any_layer.py
View File

@ -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):

4
kibot/out_download_datasheets.py
View File

@ -30,7 +30,7 @@ class Download_Datasheets_Options(VariantOptions):
""" *Name of the field containing the URL """
self.output = '${VALUE}.pdf'
""" Name used for the downloaded datasheet.
${FIELD} will be replaced by the FIELD content """
`${FIELD}` will be replaced by the FIELD content """
self.dnf = False
""" Include the DNF components """
self.repeated = False
@ -92,7 +92,7 @@ class Download_Datasheets_Options(VariantOptions):
def out_name(self, c):
""" Compute the name of the output file.
Replaces ${FIELD} and %X. """
Replaces `${FIELD}` and %X. """
out = ''
last = 0
pattern = self.output

2
kibot/pre_set_text_variables.py
View File

@ -77,7 +77,7 @@ class Set_Text_VariablesOptions(Optionable):
@pre_class
class Set_Text_Variables(BasePreFlight): # noqa: F821
""" [dict|list(dict)] Defines KiCad 6+ variables.
They are expanded using ${VARIABLE}, and stored in the project file.
They are expanded using `${VARIABLE}`, and stored in the project file.
This preflight replaces `pcb_replace` and `sch_replace` when using KiCad 6.
The KiCad project file is modified.
Warning: don't use `-s all` or this preflight will be skipped """