From 789878c627849d7ede4a8e4382a8b7d74b77352f Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Wed, 20 Nov 2024 13:36:17 -0300 Subject: [PATCH] [DOCs][Added][Consolidate_PCBs] Missing docs --- .../preflights/PCB_Reference.rst | 9 +++++++++ .../preflights/consolidate_pcbs.rst | 20 +++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 docs/source/configuration/preflights/PCB_Reference.rst create mode 100644 docs/source/configuration/preflights/consolidate_pcbs.rst diff --git a/docs/source/configuration/preflights/PCB_Reference.rst b/docs/source/configuration/preflights/PCB_Reference.rst new file mode 100644 index 00000000..ff84a50e --- /dev/null +++ b/docs/source/configuration/preflights/PCB_Reference.rst @@ -0,0 +1,9 @@ +.. _PCB_Reference: + + +PCB_Reference parameters +~~~~~~~~~~~~~~~~~~~~~~~~ + +- ``file`` :index:`: ` [:ref:`string `] (default: ``''``) PCB to insert at the textbox. +- ``name`` :index:`: ` [:ref:`string `] (default: ``''``) Text used in the textbox. + diff --git a/docs/source/configuration/preflights/consolidate_pcbs.rst b/docs/source/configuration/preflights/consolidate_pcbs.rst new file mode 100644 index 00000000..b45e13bd --- /dev/null +++ b/docs/source/configuration/preflights/consolidate_pcbs.rst @@ -0,0 +1,20 @@ +.. Automatically generated by KiBot, please don't edit this file + +.. index:: + pair: Consolidate PCBs; consolidate_pcbs + +Consolidate PCBs +~~~~~~~~~~~~~~~~ + +Paste one or more PCBs into an existing PCB. +This is experimental and isn't intended for generating a PCB to work, just for 3D modeling and/or printing. |br| +In the main PCB you just draw text boxes containing a name. Here you map this name to a PCB file name. |br| +After executing this preflight the current PCB contains the references PCBs at the text boxes coordinates. |br| +Only the top left corner of the text box is relevant + + - **consolidate_pcbs** :index:`: ` [:ref:`PCB_Reference parameters `] [:ref:`dict ` | :ref:`list(dict) `] (default: ``[]``) One or more PCBs to include. + +.. toctree:: + :caption: Used dicts + + PCB_Reference