[KiRi][KiCanvas][DOCs][Added] More information

- About local file system issues
- Link to upstream

docs/samples/generic_plot.kibot.yaml

@@ -1518,6 +1518,12 @@ outputs:
       # This isn't related to the KiBot concept of variants
       variant: ''
   # KiCanvas:
+  # Note that this tool is in alpha stage, so be ready to face some issues.
+  # Also note that most browsers won't allow Java Script to read local files,
+  # needed to load the SCH/PCB. So you must use a web server or enable the
+  # access to local files. In the case of Google Chrome you can use the
+  # `--allow-file-access-from-files` command line option.
+  # For more information visit the [KiCanvas web](https://github.com/theacodes/kicanvas)
   # 
   - name: 'kicanvas_example'
     comment: 'Generates an interactive web page to browse the schematic and/or PCB.'
@@ -1691,7 +1697,13 @@ outputs:
       template: 'default'
   # KiRi:
   # Must be applied to a git repository.
-  # Recursive git submodules aren't supported (submodules inside submodules)
+  # Recursive git submodules aren't supported (submodules inside submodules).
+  # Note that most browsers won't allow Java Script to read local files,
+  # needed to load the SCH/PCB. So you must use a web server or enable the
+  # access to local files. In the case of Google Chrome you can use the
+  # `--allow-file-access-from-files` command line option.
+  # This output generates a simple Python web server called `kiri-server` that you can use.
+  # For more information visit the [KiRi web](https://github.com/leoheck/kiri)
   - name: 'kiri_example'
     comment: 'Generates an interactive web page to browse the schematic and/or PCB differences between git commits.'
     type: 'kiri'

docs/source/configuration/outputs/kicanvas.rst

@@ -7,7 +7,12 @@ KiCanvas
 ~~~~~~~~
 
 Generates an interactive web page to browse the schematic and/or PCB.
-
+Note that this tool is in alpha stage, so be ready to face some issues. |br|
+Also note that most browsers won't allow Java Script to read local files,
+needed to load the SCH/PCB. So you must use a web server or enable the
+access to local files. In the case of Google Chrome you can use the
+`--allow-file-access-from-files` command line option. |br|
+For more information visit the `KiCanvas web <https://github.com/theacodes/kicanvas>`__
 
 Type: ``kicanvas``
 

docs/source/configuration/outputs/kiri.rst

@@ -8,7 +8,13 @@ KiRi
 
 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)
+Recursive git submodules aren't supported (submodules inside submodules). |br|
+Note that most browsers won't allow Java Script to read local files,
+needed to load the SCH/PCB. So you must use a web server or enable the
+access to local files. In the case of Google Chrome you can use the
+`--allow-file-access-from-files` command line option. |br|
+This output generates a simple Python web server called `kiri-server` that you can use. |br|
+For more information visit the `KiRi web <https://github.com/leoheck/kiri>`__
 
 Type: ``kiri``
 

kibot/out_kicanvas.py

@@ -201,6 +201,12 @@ class KiCanvasOptions(VariantOptions):
 class KiCanvas(BaseOutput):  # noqa: F821
     """ KiCanvas
         Generates an interactive web page to browse the schematic and/or PCB.
+        Note that this tool is in alpha stage, so be ready to face some issues.
+        Also note that most browsers won't allow Java Script to read local files,
+        needed to load the SCH/PCB. So you must use a web server or enable the
+        access to local files. In the case of Google Chrome you can use the
+        `--allow-file-access-from-files` command line option.
+        For more information visit the [KiCanvas web](https://github.com/theacodes/kicanvas)
     """
     def __init__(self):
         super().__init__()

kibot/out_kiri.py

@@ -342,7 +342,13 @@ class KiRi(BaseOutput):  # noqa: F821
     """ KiRi
         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) """
+        Recursive git submodules aren't supported (submodules inside submodules).
+        Note that most browsers won't allow Java Script to read local files,
+        needed to load the SCH/PCB. So you must use a web server or enable the
+        access to local files. In the case of Google Chrome you can use the
+        `--allow-file-access-from-files` command line option.
+        This output generates a simple Python web server called `kiri-server` that you can use.
+        For more information visit the [KiRi web](https://github.com/leoheck/kiri) """
     def __init__(self):
         super().__init__()
         self._category = ['PCB/docs', 'Schematic/docs']