diff --git a/docs/samples/generic_plot.kibot.yaml b/docs/samples/generic_plot.kibot.yaml index 8487fbee..03c7c075 100644 --- a/docs/samples/generic_plot.kibot.yaml +++ b/docs/samples/generic_plot.kibot.yaml @@ -1648,9 +1648,10 @@ outputs: # See KiKit's doc/present.md for template specification template: 'default' # KiRi: + # Must be applied to a git repository. # Recursive git submodules aren't supported (submodules inside submodules) - name: 'kiri_example' - comment: 'Generates a PDF with the differences between two PCBs or schematics.' + comment: 'Generates an interactive web page to browse the schematic and/or PCB differences between git commits.' type: 'kiri' dir: 'Example/kiri_dir' options: diff --git a/docs/source/configuration/outputs/kiri.rst b/docs/source/configuration/outputs/kiri.rst index 8c492e63..98ef55a4 100644 --- a/docs/source/configuration/outputs/kiri.rst +++ b/docs/source/configuration/outputs/kiri.rst @@ -6,7 +6,8 @@ KiRi ~~~~ -Generates a PDF with the differences between two PCBs or schematics. +Generates an interactive web page to browse the schematic and/or PCB differences between git commits. +Must be applied to a git repository. |br| Recursive git submodules aren't supported (submodules inside submodules) Type: ``kiri`` diff --git a/kibot/out_kiri.py b/kibot/out_kiri.py index 6d9fd685..897aeb02 100644 --- a/kibot/out_kiri.py +++ b/kibot/out_kiri.py @@ -354,7 +354,8 @@ class KiRiOptions(VariantOptions): @output_class class KiRi(BaseOutput): # noqa: F821 """ KiRi - Generates a PDF with the differences between two PCBs or schematics. + Generates an interactive web page to browse the schematic and/or PCB differences between git commits. + Must be applied to a git repository. Recursive git submodules aren't supported (submodules inside submodules) """ def __init__(self): super().__init__()