Skip to content

Commit

Permalink
[DOCs][Added][Consolidate_PCBs] Missing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
set-soft committed Nov 20, 2024
1 parent b677738 commit 789878c
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/source/configuration/preflights/PCB_Reference.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _PCB_Reference:


PCB_Reference parameters
~~~~~~~~~~~~~~~~~~~~~~~~

- ``file`` :index:`: <pair: preflight - consolidate_pcbs - consolidate_pcbs; file>` [:ref:`string <string>`] (default: ``''``) PCB to insert at the textbox.
- ``name`` :index:`: <pair: preflight - consolidate_pcbs - consolidate_pcbs; name>` [:ref:`string <string>`] (default: ``''``) Text used in the textbox.

20 changes: 20 additions & 0 deletions docs/source/configuration/preflights/consolidate_pcbs.rst
Original file line number Diff line number Diff line change
@@ -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:`: <pair: preflight - consolidate_pcbs; consolidate_pcbs>` [:ref:`PCB_Reference parameters <PCB_Reference>`] [:ref:`dict <dict>` | :ref:`list(dict) <list(dict)>`] (default: ``[]``) One or more PCBs to include.

.. toctree::
:caption: Used dicts

PCB_Reference

0 comments on commit 789878c

Please sign in to comment.