From 12fc8e6fe0a7e013d5de1eae626becbc0897cc3b Mon Sep 17 00:00:00 2001 From: "Salvador E. Tropea" Date: Thu, 24 Oct 2024 11:20:27 -0300 Subject: [PATCH] [DOCs][Added] Documentation files for "include_table" --- .../preflights/IncTableOutputOptions.rst | 21 ++++++++++++++++ .../preflights/IncludeTableOptions.rst | 17 +++++++++++++ .../preflights/include_table.rst | 24 +++++++++++++++++++ 3 files changed, 62 insertions(+) create mode 100644 docs/source/configuration/preflights/IncTableOutputOptions.rst create mode 100644 docs/source/configuration/preflights/IncludeTableOptions.rst create mode 100644 docs/source/configuration/preflights/include_table.rst diff --git a/docs/source/configuration/preflights/IncTableOutputOptions.rst b/docs/source/configuration/preflights/IncTableOutputOptions.rst new file mode 100644 index 00000000..9a60317c --- /dev/null +++ b/docs/source/configuration/preflights/IncTableOutputOptions.rst @@ -0,0 +1,21 @@ +.. _IncTableOutputOptions: + + +IncTableOutputOptions parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- **name** :index:`: ` [:ref:`string `] (default: ``''``) Name of output. +- ``bold_headers`` :index:`: ` [:ref:`boolean `] (default: ``true``) Whether or not the headers should be in bold. +- ``border_width`` :index:`: ` [:ref:`number `] (default: ``0.4``) Width of border around the table. Use 0 to eliminate it. +- ``bottom_rule_width`` :index:`: ` [:ref:`number `] (default: ``0.4``) Width of bottom rule (bottom of table). Use 0 to eliminate it. +- ``column_spacing`` :index:`: ` [:ref:`number `] (default: ``2``) Blank space (in number of characters) between columns. +- ``has_header`` :index:`: ` [:ref:`boolean `] (default: ``true``) Plot header on the table. +- ``header_rule_width`` :index:`: ` [:ref:`number `] (default: ``0.3``) Width of rule below header. Use 0 to eliminate it. +- ``horizontal_rule_width`` :index:`: ` [:ref:`number `] (default: ``0.1``) Width of vertical rules between rows (doesn't include header) + Use 0 to eliminate it. +- ``invert_columns_order`` :index:`: ` [:ref:`boolean `] (default: ``false``) Invert column order. Useful when inverting PCB texts in PCB Print. +- ``row_spacing`` :index:`: ` [:ref:`number `] (default: ``2``) Space (in number of characters) between rows. +- ``text_alignment`` :index:`: ` [:ref:`string `] (default: ``'left'``) (choices: "left", "center", "right") Text alignment in the table. +- ``top_rule_width`` :index:`: ` [:ref:`number `] (default: ``0.4``) Width of top rule (above header). Use 0 to eliminate it. +- ``vertical_rule_width`` :index:`: ` [:ref:`number `] (default: ``0.1``) Width of vertical rules between columns. Use 0 to eliminate it. + diff --git a/docs/source/configuration/preflights/IncludeTableOptions.rst b/docs/source/configuration/preflights/IncludeTableOptions.rst new file mode 100644 index 00000000..90f214d5 --- /dev/null +++ b/docs/source/configuration/preflights/IncludeTableOptions.rst @@ -0,0 +1,17 @@ +.. _IncludeTableOptions: + + +IncludeTableOptions parameters +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +- **outputs** :index:`: ` [:ref:`IncTableOutputOptions parameters `] [:ref:`list(dict) ` | :ref:`list(string) ` | :ref:`string `] (default: ``[]``) List of CSV-generating outputs. +- ``enabled`` :index:`: ` [:ref:`boolean `] (default: ``true``) Enable the check. This is the replacement for the boolean value. +- ``group_name`` :index:`: ` [:ref:`string `] (default: ``'kibot_table'``) Name for the group containing the table. The name of the group + should be _X where X is the output name. + When the output generates more than one CSV use *kibot_table_out[2]* + to select the second CSV. + +.. toctree:: + :caption: Used dicts + + IncTableOutputOptions diff --git a/docs/source/configuration/preflights/include_table.rst b/docs/source/configuration/preflights/include_table.rst new file mode 100644 index 00000000..c94dbe98 --- /dev/null +++ b/docs/source/configuration/preflights/include_table.rst @@ -0,0 +1,24 @@ +.. Automatically generated by KiBot, please don't edit this file + +.. index:: + pair: Include Table; include_table + +Include Table +~~~~~~~~~~~~~ + +Includes CSV Table generated by an output. Needs KiCad 7 or newer. +To specify the position and size of the drawing you should draw a rectangle in your PCB +with the width and layer you want. |br| +Then draw another thing inside the rectangle, select both and create a group +(right mouse button, then Grouping -> Group). Now edit the group and change its name +to *kibot_table_X* where X should match the name of the output. Consult the +`group_name` option for details. |br| +After running this preflight the rectangle will contain the table with the same name. |br| +Only the width of the table is important, the height will be adjusted + + - **include_table** :index:`: ` [:ref:`IncludeTableOptions parameters `] [:ref:`boolean ` | :ref:`dict `] (default: ``false``) Use a boolean for simple cases or fine-tune its behavior. + +.. toctree:: + :caption: Used dicts + + IncludeTableOptions