[KiCad Site][Added] KiRi

Author: set-soft

CHANGELOG.md

@@ -18,6 +18,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - `tag_filter`: to select which tags are used for KIBOT_TAG
 - KiCad Site:
   - `bom` configuration
+  - `kiri` configuration
+
+## Fixed
+- KiRi:
+  - `kiri_server` path to the HTML
 
 ## Changed
 - E/DRC and BoM: As we now have dark mode support the CSS is more complex and

docs/samples/generic_plot.kibot.yaml

@@ -2311,6 +2311,8 @@ outputs:
       force_copy: false
       # [string=''] Name of the iBoM output. Use `None` to skip
       ibom: ''
+      # [string=''] Name of the KiRi output to use as embedded HTML. Use `None` to skip
+      kiri: ''
       # [boolean=false] List the PCB first, KiCanvas will show the PCB by default, instead of the schematic
       pcb_first: false
       # [string|list(string)=''] Name of one or more outputs providing images for the PCB

docs/source/Changelog.rst

@@ -39,6 +39,14 @@ Added
 -  KiCad Site:
 
    -  ``bom`` configuration
+   -  ``kiri`` configuration
+
+Fixed
+-----
+
+-  KiRi:
+
+   -  ``kiri_server`` path to the HTML
 
 Changed
 -------
@@ -134,6 +142,8 @@ Added
    KiCad 10
 -  SCH Print: specify pages to be included (#907)
 
+.. _fixed-1:
+
 Fixed
 ~~~~~
 
@@ -230,7 +240,7 @@ Added
 -  Blender Export: Support for STL/OBJ/PLY/GLTF changes in Blender 4.2
    (#880)
 
-.. _fixed-1:
+.. _fixed-2:
 
 Fixed
 ~~~~~
@@ -284,7 +294,7 @@ Added
    -  ``Footprint Full`` virtual field for the ``LIB:FOOTPRINT`` name
    -  ``kicad_dnp_applied`` option to overwrite the global option
 
-.. _fixed-2:
+.. _fixed-3:
 
 Fixed
 ~~~~~
@@ -440,7 +450,7 @@ Added
 
    -  Default font for KiCad 9 (#691)
 
-.. _fixed-3:
+.. _fixed-4:
 
 Fixed
 ~~~~~
@@ -542,7 +552,7 @@ Added
    -  ``copy_vias_on_mask`` option to workaround KiCad’s bug 18991 (See
       #703 and #704)
 
-.. _fixed-4:
+.. _fixed-5:
 
 Fixed
 ~~~~~
@@ -591,7 +601,7 @@ Changed
 `1.8.1 <https://github.com/INTI-CMNB/KiBot/compare/v1.8.0...v1.8.1>`__ - 2024-09-25
 -----------------------------------------------------------------------------------
 
-.. _fixed-5:
+.. _fixed-6:
 
 Fixed
 ~~~~~
@@ -672,7 +682,7 @@ Added
 
    -  Support for panels repeating the same component (See #656)
 
-.. _fixed-6:
+.. _fixed-7:
 
 Fixed:
 ~~~~~~
@@ -826,7 +836,7 @@ Added
    -  Added options to control Eco1/Eco2/Drawings individually on KiCad
       8 (#614)
 
-.. _fixed-7:
+.. _fixed-8:
 
 Fixed
 ~~~~~
@@ -896,7 +906,7 @@ Changed
 -  BoardView: Skip footprints with no pads (not just REF*\*)
    (whitequark/kicad-boardview#14)
 
-.. _fixed-8:
+.. _fixed-9:
 
 Fixed
 ~~~~~
@@ -1116,7 +1126,7 @@ Changed
    -  When *check_zone_fills* is enabled now we do a refill for the
       boards
 
-.. _fixed-9:
+.. _fixed-10:
 
 Fixed
 ~~~~~
@@ -1334,7 +1344,7 @@ Changed
 -  JLCPCB_stencil: Is now just like JLCPCB. The only difference is the
    added layers.
 
-.. _fixed-10:
+.. _fixed-11:
 
 Fixed
 ~~~~~
@@ -1444,7 +1454,7 @@ Added
 
    -  Option to use the auxiliary origin as reference. (#420)
 
-.. _fixed-11:
+.. _fixed-12:
 
 Fixed
 ~~~~~
@@ -1531,7 +1541,7 @@ Added
    -  ``cross_using_kicad`` global option to use KiCad to cross DNP
       components in the schematic. Enabled by default.
 
-.. _fixed-12:
+.. _fixed-13:
 
 Fixed
 ~~~~~
@@ -1665,7 +1675,7 @@ Added
 `1.5.1 <https://github.com/INTI-CMNB/KiBot/compare/v1.5.0...v1.5.1>`__ - 2022-12-16
 -----------------------------------------------------------------------------------
 
-.. _fixed-13:
+.. _fixed-14:
 
 Fixed
 ~~~~~
@@ -1752,7 +1762,7 @@ Changed
 
    -  loss tangent decimals, added one more.
 
-.. _fixed-14:
+.. _fixed-15:
 
 Fixed
 ~~~~~
@@ -1862,7 +1872,7 @@ Added
 
 -  Position: option to set the resolution for floating values (#314)
 
-.. _fixed-15:
+.. _fixed-16:
 
 Fixed
 ~~~~~
@@ -1952,7 +1962,7 @@ Added
 
 -  Installation checker: option to show the tool paths.
 
-.. _fixed-16:
+.. _fixed-17:
 
 Fixed
 ~~~~~
@@ -2036,7 +2046,7 @@ Added
 -  GitHub discussions are now enabled. Comment about your KiBot
    experience `here <https://github.com/INTI-CMNB/KiBot/discussions>`__
 
-.. _fixed-17:
+.. _fixed-18:
 
 Fixed
 ~~~~~
@@ -2084,7 +2094,7 @@ Added
    -  Pattern and text variables expansion in the title (#198)
    -  Customizable extra info after the title (#199)
 
-.. _fixed-18:
+.. _fixed-19:
 
 Fixed
 ~~~~~
@@ -2232,7 +2242,7 @@ Changed
 -  The default output pattern now includes the ``output_id`` (%I)
 -  The ``source`` path for ``compress`` now has pattern expansion (#152)
 
-.. _fixed-19:
+.. _fixed-20:
 
 Fixed
 ~~~~~
@@ -2314,7 +2324,7 @@ Changed
 -  Reference ranges of two elements no longer represented as ranges.
    Examples: “R1-R2” is now “R1 R2”, “R1-R3” remains unchanged.
 
-.. _fixed-20:
+.. _fixed-21:
 
 Fixed
 ~~~~~
@@ -2346,7 +2356,7 @@ Added
 [0.10.0-4] - 2021-02-16
 -----------------------
 
-.. _fixed-21:
+.. _fixed-22:
 
 Fixed
 ~~~~~
@@ -2358,7 +2368,7 @@ Fixed
 [0.10.0-3] - 2021-02-16
 -----------------------
 
-.. _fixed-22:
+.. _fixed-23:
 
 Fixed
 ~~~~~
@@ -2370,7 +2380,7 @@ Fixed
 [0.10.0-2] - 2021-02-12
 -----------------------
 
-.. _fixed-23:
+.. _fixed-24:
 
 Fixed
 ~~~~~
@@ -2428,7 +2438,7 @@ Changed
    and error messages still use stderr.
 -  Now InteractiveHtmlBom can be installed just as a plugin.
 
-.. _fixed-24:
+.. _fixed-25:
 
 Fixed
 ~~~~~
@@ -2469,7 +2479,7 @@ Changed
 -  Position files in CSV format quotes only the columns that could
    contain an space. Just like KiCad does.
 
-.. _fixed-25:
+.. _fixed-26:
 
 Fixed
 ~~~~~
@@ -2491,7 +2501,7 @@ Added
 -  Internal BoM HTML: highlight cell when hover.
 -  Internal BoM HTML: allow to jump to REF of row number using anchors.
 
-.. _fixed-26:
+.. _fixed-27:
 
 Fixed
 ~~~~~
@@ -2517,7 +2527,7 @@ Added
 -  Columns in position files can be selected, renamed and sorted as you
    like.
 
-.. _fixed-27:
+.. _fixed-28:
 
 Fixed
 ~~~~~
@@ -2560,7 +2570,7 @@ Added
 -  Default output file name format and default variant can be specified
    from the command line.
 
-.. _fixed-28:
+.. _fixed-29:
 
 Fixed
 ~~~~~
@@ -2582,7 +2592,7 @@ Changed
    creating the internal BoM. They are usually mistakes that prevents
    grouping components.
 
-.. _fixed-29:
+.. _fixed-30:
 
 Fixed
 ~~~~~
@@ -2613,7 +2623,7 @@ Changed
 
 -  Incorporated mcpy, no longer a dependency.
 
-.. _fixed-30:
+.. _fixed-31:
 
 Fixed
 ~~~~~
@@ -2749,7 +2759,7 @@ Added
    -  variants_blacklist
    -  dnp_field
 
-.. _fixed-31:
+.. _fixed-32:
 
 Fixed
 ~~~~~
@@ -2793,7 +2803,7 @@ Changed
    missing or corrupted.
 -  The ‘check_zone_fills’ option is now independent of ‘run_drc’
 
-.. _fixed-32:
+.. _fixed-33:
 
 Fixed
 ~~~~~
@@ -2813,7 +2823,7 @@ Added
 -  Tolerate config files without outputs
 -  Mechanism to filter ERC/DRC errors
 
-.. _fixed-33:
+.. _fixed-34:
 
 Fixed
 ~~~~~
@@ -2833,7 +2843,7 @@ Changed
 
 -  Now kicad-automation-scripts 1.3.1 or newer is needed.
 
-.. _fixed-34:
+.. _fixed-35:
 
 Fixed
 ~~~~~
@@ -2858,7 +2868,7 @@ Added
 `0.2.2 <https://github.com/INTI-CMNB/KiBot/compare/v0.2.1...v0.2.2>`__ - 2020-04-20
 -----------------------------------------------------------------------------------
 
-.. _fixed-35:
+.. _fixed-36:
 
 Fixed
 ~~~~~
@@ -2871,7 +2881,7 @@ Fixed
 `0.2.1 <https://github.com/INTI-CMNB/KiBot/compare/v0.2.0...v0.2.1>`__ - 2020-04-18
 -----------------------------------------------------------------------------------
 
-.. _fixed-36:
+.. _fixed-37:
 
 Fixed
 ~~~~~
@@ -2902,7 +2912,7 @@ Added
 -  Progress information
 -  –version option
 
-.. _fixed-37:
+.. _fixed-38:
 
 Fixed
 ~~~~~

docs/source/configuration/outputs/KiCad_SiteOptions.rst

@@ -18,6 +18,7 @@ KiCad_SiteOptions parameters
 -  ``force_copy`` :index:`: <pair: output - kicad_site - options; force_copy>` [:ref:`boolean <boolean>`] (default: ``false``) By default we skip the copy to the destination dir if the file is already there and newer.
    Enabling this option we always do the copy.
 -  ``ibom`` :index:`: <pair: output - kicad_site - options; ibom>` [:ref:`string <string>`] (default: ``''``) Name of the iBoM output. Use `None` to skip.
+-  ``kiri`` :index:`: <pair: output - kicad_site - options; kiri>` [:ref:`string <string>`] (default: ``''``) Name of the KiRi output to use as embedded HTML. Use `None` to skip.
 -  ``pcb_first`` :index:`: <pair: output - kicad_site - options; pcb_first>` [:ref:`boolean <boolean>`] (default: ``false``) List the PCB first, KiCanvas will show the PCB by default, instead of the schematic.
 -  ``renders`` :index:`: <pair: output - kicad_site - options; renders>` [:ref:`string <string>` | :ref:`list(string) <list(string)>`] (default: ``''``) Name of one or more outputs providing images for the PCB.