diff --git a/README.md b/README.md index 57983516..3aa7217a 100644 --- a/README.md +++ b/README.md @@ -1844,7 +1844,7 @@ Notes: - **`format`**: [string='HTML'] [HTML,CSV,XML,XLSX] Format for the BoM. - **`number`**: [number=1] Number of boards to build (components multiplier). - **`output`**: [string='%f-%i%I%v.%x'] Filename for the output (%i=bom). Affected by global options. - - `conf`: [string|dict] BoM configuration file, relative to PCB. + - `conf`: [string|dict] BoM configuration file, relative to PCB. Environment variables and ~ allowed. You can also define the configuration here, will be stored in `config.kibom.ini`. * Valid keys: - **`columns`**: [list(dict)|list(string)] List of columns to display. @@ -2588,6 +2588,7 @@ Notes: In Debian/Ubuntu environments: install `pandoc`, `texlive-latex-base` and `texlive-latex-recommended`. - **`output`**: [string='%f-%i%I%v.%x'] Output file name (%i='report', %x='txt'). Affected by global 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`: [string='markdown'] Original format for the report conversion. Current templates are `markdown`. See `do_convert`. - `converted_output`: [string='%f-%i%I%v.%x'] Converted output file name (%i='report', %x=`convert_to`). diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 34d9b093..8d5d87bf 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -797,7 +797,7 @@ outputs: type: 'kibom' dir: 'Example/kibom_dir' options: - # [string|dict] BoM configuration file, relative to PCB. + # [string|dict] BoM configuration file, relative to PCB. Environment variables and ~ allowed. # You can also define the configuration here, will be stored in `config.kibom.ini` conf: # [list(dict)|list(string)] List of columns to display. @@ -1546,6 +1546,7 @@ outputs: # [string='%f-%i%I%v.%x'] Output file name (%i='report', %x='txt'). Affected by global options output: '%f-%i%I%v.%x' # [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`) template: 'full' # Schematic with variant generator: diff --git a/kibot/out_kibom.py b/kibot/out_kibom.py index 8b3f69d1..70bfb589 100644 --- a/kibot/out_kibom.py +++ b/kibot/out_kibom.py @@ -342,7 +342,7 @@ class KiBoMOptions(BaseOptions): variants with the ';' (semicolon) character. This isn't related to the KiBot concept of variants """ self.conf = KiBoMConfig - """ [string|dict] BoM configuration file, relative to PCB. + """ [string|dict] BoM configuration file, relative to PCB. Environment variables and ~ allowed. You can also define the configuration here, will be stored in `config.kibom.ini` """ self.separator = ',' """ CSV Separator """ diff --git a/kibot/out_report.py b/kibot/out_report.py index 8d0f4ddc..39925126 100644 --- a/kibot/out_report.py +++ b/kibot/out_report.py @@ -177,6 +177,7 @@ class ReportOptions(BaseOptions): """ *Output file name (%i='report', %x='txt') """ self.template = '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`) """ self.convert_from = 'markdown' """ Original format for the report conversion. Current templates are `markdown`. See `do_convert` """