forked from johnbeard/kiplot
-
Notifications
You must be signed in to change notification settings - Fork 66
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCs][Added][Consolidate_PCBs] Missing docs
- Loading branch information
Showing
2 changed files
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |