[Report] Support for multi-page PDFs of SCH/PCB

- So now we can use SVGs or PDFs for both

Author: set-soft

CHANGELOG.md

@@ -19,14 +19,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - KiCad Site:
   - `bom` configuration
   - `kiri` configuration
+- Report:
+  - All PDF pages are included, not just the first
+  - The full report now works with SVGs and PDFs for both (SCH and PCB),
+    SVGs have priority
+  - `remove_split_pdfs`: To control if we remove split PDFs
 
 ## Fixed
 - KiRi:
   - `kiri_server` path to the HTML
 - *SCH Print:
   - The list of targets now includes all schematic pages
 - Report:
-  - Now all schematic pages are included, not just the first
+  - Now all SVG schematic pages are included, not just the first
 
 ## Changed
 - E/DRC and BoM: As we now have dark mode support the CSS is more complex and
@@ -35,8 +40,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   created output is displayed.
 - When using `pcb_print` and including tables you no longer need to run the
   output that generates the CSV first, it gets generated on-the-fly
-- When using `report` the outputs that generates images no longer needs to be
-  already executed, KiBot will run them
+- Report: the outputs that generates images no longer needs to be already
+  executed, KiBot will run them
 
 
 ## [1.9.0] - 2026-05-12

docs/samples/generic_plot.kibot.yaml

@@ -4659,6 +4659,10 @@ outputs:
       # Can be used to fine-tune a variant for a particular output that needs extra filtering done before the
       # variant
       pre_transform: '_null'
+      # [string='auto'] [auto,yes,no] When we use PDF files they are split because `pandoc` can't deal with more than
+      # one page. You can delete them after converting the output. The `auto` value will do it when
+      # `do_convert` is enabled
+      remove_split_pdfs: 'auto'
       # [number=87.75] [0,100] Amount of metal in the solder paste (percentage). Used to compute solder paste usage
       solder_paste_metal_amount: 87.75
       # [number=0.12] Stencil thickness in mm. Used to compute solder paste usage

docs/source/Changelog.rst

@@ -41,6 +41,13 @@ Added
    -  ``bom`` configuration
    -  ``kiri`` configuration
 
+-  Report:
+
+   -  All PDF pages are included, not just the first
+   -  The full report now works with SVGs and PDFs for both (SCH and
+      PCB), SVGs have priority
+   -  ``remove_split_pdfs``: To control if we remove split PDFs
+
 Fixed
 -----
 
@@ -54,7 +61,7 @@ Fixed
 
 -  Report:
 
-   -  Now all schematic pages are included, not just the first
+   -  Now all SVG schematic pages are included, not just the first
 
 Changed
 -------
@@ -66,8 +73,8 @@ Changed
 -  When using ``pcb_print`` and including tables you no longer need to
    run the output that generates the CSV first, it gets generated
    on-the-fly
--  When using ``report`` the outputs that generates images no longer
-   needs to be already executed, KiBot will run them
+-  Report: the outputs that generates images no longer needs to be
+   already executed, KiBot will run them
 
 [1.9.0] - 2026-05-12
 --------------------

docs/source/configuration/outputs/ReportOptions.rst

@@ -51,6 +51,9 @@ ReportOptions parameters
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the
    variant.
 
+-  ``remove_split_pdfs`` :index:`: <pair: output - report - options; remove_split_pdfs>` [:ref:`string <string>`] (default: ``'auto'``) (choices: "auto", "yes", "no") When we use PDF files they are split because `pandoc` can't deal with more than
+   one page. You can delete them after converting the output. The `auto` value will do it when
+   `do_convert` is enabled.
 -  ``solder_paste_metal_amount`` :index:`: <pair: output - report - options; solder_paste_metal_amount>` [:ref:`number <number>`] (default: ``87.75``) (range: 0 to 100) Amount of metal in the solder paste (percentage). Used to compute solder paste usage.
 -  ``stencil_thickness`` :index:`: <pair: output - report - options; stencil_thickness>` [:ref:`number <number>`] (default: ``0.12``) Stencil thickness in mm. Used to compute solder paste usage.
 -  ``variant`` :index:`: <pair: output - report - options; variant>` [:ref:`string <string>`] (default: ``''``) Board variant to apply.

kibot/create_pdf.py

@@ -1,10 +1,12 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2022 Salvador E. Tropea
-# Copyright (c) 2022 Instituto Nacional de Tecnología Industrial
+# Copyright (c) 2022-2026 Salvador E. Tropea
+# Copyright (c) 2022-2026 Instituto Nacional de Tecnología Industrial
 # Copyright (c) 2022 Albin Dennevi (create_pdf_from_pages)
-# License: GPL-3.0
+# License: AGPL-3.0
 # Project: KiBot (formerly KiPlot)
-# Base idea: https://gitlab.com/dennevi/Board2Pdf/ (Released as Public Domain)
+# Base idea for create_pdf_from_pages: https://gitlab.com/dennevi/Board2Pdf/ (Released as Public Domain)
+# Base idea for split_pdf: Gemini 3.1 Pro
+import os
 from . import PyPDF2
 from . import log
 
@@ -34,3 +36,26 @@ def create_pdf_from_pages(input_files, output_fn, forced_width=None):
     # Close the files
     for f in open_files:
         f.close()
+
+
+def split_pdf(input_pdf):
+    with open(input_pdf, "rb") as infile:
+        reader = PyPDF2.PdfFileReader(infile)
+        num_pages = len(reader.pages)
+
+        if num_pages == 1:
+            return [input_pdf]
+
+        base_name = os.path.splitext(input_pdf)[0]
+        created = []
+        for i in range(num_pages):
+            writer = PyPDF2.PdfFileWriter()
+            writer.addPage(reader.pages[i])
+
+            output_filepath = f"{base_name}-{i+1}.pdf"
+
+            logger.error(output_filepath)
+            created.append(output_filepath)
+            with open(output_filepath, "wb") as outfile:
+                writer.write(outfile)
+    return created

kibot/out_report.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
-# Copyright (c) 2022-2024 Salvador E. Tropea
-# Copyright (c) 2022-2024 Instituto Nacional de Tecnología Industrial
+# Copyright (c) 2022-2026 Salvador E. Tropea
+# Copyright (c) 2022-2026 Instituto Nacional de Tecnología Industrial
 # License: AGPL-3.0
 # Project: KiBot (formerly KiPlot)
 """
@@ -20,6 +20,7 @@
 import re
 import pcbnew
 
+from .create_pdf import split_pdf
 from .gs import GS
 from .misc import (UI_SMD, UI_VIRTUAL, MOD_THROUGH_HOLE, MOD_SMD, MOD_EXCLUDE_FROM_POS_FILES, W_WRONGEXT, W_UNKPADSH,
                    W_WRONGOAR, W_ECCLASST, W_BLINDVIAS, W_MICROVIAS, W_BURIEDVIAS)
@@ -238,6 +239,10 @@ def __init__(self):
             self.csv_remove_leading_spaces = False
             """ Remove any leading spaces/tabs at the end of each separator.
                 Used por templates that generates CSV files where elements are aligned for easier reading """
+            self.remove_split_pdfs = 'auto'
+            """ [auto,yes,no] When we use PDF files they are split because `pandoc` can't deal with more than
+                one page. You can delete them after converting the output. The `auto` value will do it when
+                `do_convert` is enabled """
         super().__init__()
         self._expand_id = 'report'
         self._expand_ext = 'txt'
@@ -1137,7 +1142,7 @@ def expand_converted_output(self, out_dir):
     def get_targets(self, out_dir):
         files = [self._parent.expand_filename(out_dir, self.output)]
         if self.do_convert:
-            files.append(self.expand_converted_output(out_dir))
+            files.insert(0, self.expand_converted_output(out_dir))
         return files
 
     def convert(self, fname):
@@ -1183,6 +1188,7 @@ def run(self, fname):
         self._layer_svgs = []
         self._schematic_pdfs = []
         self._schematic_svgs = []
+        split_pdfs = []
         for o in RegOutput.get_outputs():
             dest = None
             if o.type == 'pdf_pcb_print' or o.type == 'pcb_print':
@@ -1210,13 +1216,24 @@ def run(self, fname):
                     comment = o.comment
                     if is_pcb_print_svg and o.options.pages[n].sheet:
                         comment += ' '+o.options.pages[n].sheet
+                    # Split PDFs, otherwise we get the first page
+                    if of.endswith('.pdf'):
+                        split = split_pdf(of)
+                        split_pdfs.extend(split)
+                        if len(split) > 1:
+                            for pdf_page, pdf_name in enumerate(split):
+                                dest.append((os.path.relpath(pdf_name, base_dir), comment+f" page {pdf_page+1}", o.name))
+                            continue
                     dest.append((rel_path, comment, o.name))
         self.layer_pdfs = len(self._layer_pdfs) > 0
         self.layer_svgs = len(self._layer_svgs) > 0
         self.schematic_pdfs = len(self._schematic_pdfs) > 0
         self.schematic_svgs = len(self._schematic_svgs) > 0
         self.do_template(self.template, fname)
         self.convert(fname)
+        if self.remove_split_pdfs == 'yes' or (self.remove_split_pdfs == 'auto' and self.do_convert):
+            for pdf_name in split_pdfs:
+                os.remove(pdf_name)
 
 
 @output_class

kibot/resources/report_templates/report_full.txt

@@ -133,9 +133,25 @@ Note: this is just an approximation to the theoretical value. Margins of the sol
 #schematic_svgs:![${comment}](${path}){ width=16.5cm height=11.7cm }${new_line}
 
 
-#?layer_pdfs
+#?schematic_pdfs and not schematic_svgs
+# Schematic
+#?schematic_pdfs and not schematic_svgs
+
+#?schematic_pdfs and not schematic_svgs
+#schematic_pdfs:![${comment}](${path}){ width=16.5cm height=11.7cm }${new_line}
+
+
+#?layer_svgs
+# PCB Layers
+#?layer_svgs
+
+#?layer_svgs
+#layer_svgs:![${comment}](${path}){ width=16.5cm height=11.7cm }${new_line}
+
+
+#?layer_pdfs and not layer_svgs
 # PCB Layers
-#?layer_pdfs
+#?layer_pdfs and not layer_svgs
 
-#?layer_pdfs
+#?layer_pdfs and not layer_svgs
 #layer_pdfs:![${comment}](${path}){ width=16.5cm height=11.7cm }${new_line}

kibot/resources/report_templates/report_full_svg.txt

@@ -133,9 +133,25 @@ Note: this is just an approximation to the theoretical value. Margins of the sol
 #schematic_svgs:![${comment}](${path}){ width=16.5cm height=11.7cm }${new_line}
 
 
+#?schematic_pdfs and not schematic_svgs
+# Schematic
+#?schematic_pdfs and not schematic_svgs
+
+#?schematic_pdfs and not schematic_svgs
+#schematic_pdfs:![${comment}](${path}){ width=16.5cm height=11.7cm }${new_line}
+
+
 #?layer_svgs
 # PCB Layers
 #?layer_svgs
 
 #?layer_svgs
 #layer_svgs:![${comment}](${path}){ width=16.5cm height=11.7cm }${new_line}
+
+
+#?layer_svgs and not layer_svgs
+# PCB Layers
+#?layer_svgs and not layer_svgs
+
+#?layer_svgs and not layer_svgs
+#layer_svgs:![${comment}](${path}){ width=16.5cm height=11.7cm }${new_line}

tests/GUI/outputs

@@ -14411,6 +14411,13 @@
           ],
           null
         ],
+        [
+          "remove_split_pdfs",
+          [
+            "DataTypeChoice"
+          ],
+          null
+        ],
         [
           "variant",
           [

tests/GUI/stats

@@ -1,5 +1,5 @@
-56 outputs types with a total of 2249 different parameters
-Single type parameters: 2058 (92 %)
+56 outputs types with a total of 2250 different parameters
+Single type parameters: 2059 (92 %)
 Multi type parameters: 191 (8 %)
 Average parameters: 40
 Maximum number of parameters: 218
@@ -61,10 +61,10 @@ Outputs sorted by parameters:
 - pdf_pcb_print: 31
 - kicad_site: 33
 - position: 33
-- report: 33
 - svg_pcb_print: 33
 - gerb_drill: 34
 - pcb2blender_tools: 34
+- report: 34
 - vrml: 34
 - kicost: 37
 - diff: 42
@@ -157,7 +157,7 @@ Outputs sorted by depth:
 -            Boolean:  566
 - ListStringSingular:  307
 -             Number:  304
--             Choice:  112
+-             Choice:  113
 -               Dict:   92
 -   ListDictOrString:   24
 -           ListDict:   20
@@ -173,7 +173,7 @@ Used as single data type:
 -            Boolean:  496 
 - ListStringSingular:  303 
 -             Number:  210 
--             Choice:  109 
+-             Choice:  110 
 -               Dict:   79 
 -           ListDict:   20 
 -         ListString:    9 ['blender_export.options.pcb3d.highlight', 'bom.options.group_fields', 'bom.options.group_fields_fallbacks', 'bom.options.no_conflict', 'kibom.options.conf.group_fields', 'pcbdraw.options.libs', 'pcbdraw.options.highlight', 'render_3d.options.highlight', 'vrml.options.highlight']
@@ -414,8 +414,8 @@ Used as single data type:
 -              Number,String:   15 
 ================================================================================
 ================================================================================
-97 totals types with a total of 2647 different parameters
-Single type parameters: 2430 (92 %)
+97 totals types with a total of 2648 different parameters
+Single type parameters: 2431 (92 %)
 Multi type parameters: 217 (8 %)
 Average parameters: 27
 Maximum number of parameters: 218
@@ -517,10 +517,10 @@ Totals sorted by parameters:
 - pdf_pcb_print: 31
 - kicad_site: 33
 - position: 33
-- report: 33
 - svg_pcb_print: 33
 - gerb_drill: 34
 - pcb2blender_tools: 34
+- report: 34
 - vrml: 34
 - generic: 35
 - kicost: 37
@@ -655,7 +655,7 @@ Totals sorted by depth:
 -            Boolean:  669
 -             Number:  357
 - ListStringSingular:  337
--             Choice:  144
+-             Choice:  145
 -               Dict:  103
 -           ListDict:   30
 -   ListDictOrString:   27
@@ -671,7 +671,7 @@ Used as single data type:
 -            Boolean:  589 
 - ListStringSingular:  333 
 -             Number:  248 
--             Choice:  141 
+-             Choice:  142 
 -               Dict:   82 
 -           ListDict:   30 
 -   ListDictSingular:   15