[DOCs] Added link to KiCOst CI/CD example

README.md

@@ -1793,6 +1793,7 @@ Notes:
             - **`datasheet_as_link`**: [string=''] Column with links to the datasheet.
             - **`generate_dnf`**: [boolean=true] Generate a separated section for DNF (Do Not Fit) components.
             - **`kicost`**: [boolean=false] Enable KiCost worksheet creation.
+                            Note: an example of how to use it on CI/CD can be found [here](https://github.com/set-soft/kicost_ci_test).
             - **`logo`**: [string|boolean=''] PNG file to use as logo, use false to remove.
             - **`specs`**: [boolean=false] Enable Specs worksheet creation. Contains specifications for the components.
                            Works with only some KiCost APIs.
@@ -2801,6 +2802,7 @@ Notes:
   * Description: Generates a spreadsheet containing components costs.
                  For more information: https://github.com/INTI-CMNB/KiCost
                  This output is what you get from the KiCost plug-in (eeschema).
+                 You can get KiCost costs using the internal BoM output (`bom`).
   * Valid keys:
     - **`comment`**: [string=''] A comment for documentation purposes. It helps to identify the output.
     - **`dir`**: [string='./'] Output directory for the generated files.

docs/samples/generic_plot.kibot.yaml

@@ -515,7 +515,8 @@ outputs:
         hide_stats_info: false
         # [boolean=true] Use a color for empty cells. Applies only when `col_colors` is `true`
         highlight_empty: true
-        # [boolean=false] Enable KiCost worksheet creation
+        # [boolean=false] Enable KiCost worksheet creation.
+        # Note: an example of how to use it on CI/CD can be found [here](https://github.com/set-soft/kicost_ci_test)
         kicost: false
         # [string|list(string)=''] List of KiCost APIs to disable
         kicost_api_disable: ''
@@ -1391,6 +1392,7 @@ outputs:
   # KiCost (KiCad Cost calculator):
   # For more information: https://github.com/INTI-CMNB/KiCost
   # This output is what you get from the KiCost plug-in (eeschema).
+  # You can get KiCost costs using the internal BoM output (`bom`).
   - name: 'kicost_example'
     comment: 'Generates a spreadsheet containing components costs.'
     type: 'kicost'

kibot/out_bom.py

@@ -306,7 +306,8 @@ class BoMXLSX(BoMLinkable):
             self.style = 'modern-blue'
             """ Head style: modern-blue, modern-green, modern-red and classic """
             self.kicost = False
-            """ *Enable KiCost worksheet creation """
+            """ *Enable KiCost worksheet creation.
+                Note: an example of how to use it on CI/CD can be found [here](https://github.com/set-soft/kicost_ci_test) """
             self.kicost_api_enable = Optionable
             """ [string|list(string)=''] List of KiCost APIs to enable """
             self.kicost_api_disable = Optionable

kibot/out_kicost.py

@@ -235,7 +235,8 @@ class KiCost(BaseOutput):  # noqa: F821
     """ KiCost (KiCad Cost calculator)
         Generates a spreadsheet containing components costs.
         For more information: https://github.com/INTI-CMNB/KiCost
-        This output is what you get from the KiCost plug-in (eeschema). """
+        This output is what you get from the KiCost plug-in (eeschema).
+        You can get KiCost costs using the internal BoM output (`bom`). """
     def __init__(self):
         super().__init__()
         self._sch_related = True