[DOCs][Added] Documentation files for "include_table"

docs/source/configuration/preflights/IncTableOutputOptions.rst

@@ -0,0 +1,21 @@
+.. _IncTableOutputOptions:
+
+
+IncTableOutputOptions parameters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  **name** :index:`: <pair: preflight - include_table - include_table - outputs; name>` [:ref:`string <string>`] (default: ``''``) Name of output.
+-  ``bold_headers`` :index:`: <pair: preflight - include_table - include_table - outputs; bold_headers>` [:ref:`boolean <boolean>`] (default: ``true``) Whether or not the headers should be in bold.
+-  ``border_width`` :index:`: <pair: preflight - include_table - include_table - outputs; border_width>` [:ref:`number <number>`] (default: ``0.4``) Width of border around the table. Use 0 to eliminate it.
+-  ``bottom_rule_width`` :index:`: <pair: preflight - include_table - include_table - outputs; bottom_rule_width>` [:ref:`number <number>`] (default: ``0.4``) Width of bottom rule (bottom of table). Use 0 to eliminate it.
+-  ``column_spacing`` :index:`: <pair: preflight - include_table - include_table - outputs; column_spacing>` [:ref:`number <number>`] (default: ``2``) Blank space (in number of characters) between columns.
+-  ``has_header`` :index:`: <pair: preflight - include_table - include_table - outputs; has_header>` [:ref:`boolean <boolean>`] (default: ``true``) Plot header on the table.
+-  ``header_rule_width`` :index:`: <pair: preflight - include_table - include_table - outputs; header_rule_width>` [:ref:`number <number>`] (default: ``0.3``) Width of rule below header. Use 0 to eliminate it.
+-  ``horizontal_rule_width`` :index:`: <pair: preflight - include_table - include_table - outputs; horizontal_rule_width>` [:ref:`number <number>`] (default: ``0.1``) Width of vertical rules between rows (doesn't include header)
+   Use 0 to eliminate it.
+-  ``invert_columns_order`` :index:`: <pair: preflight - include_table - include_table - outputs; invert_columns_order>` [:ref:`boolean <boolean>`] (default: ``false``) Invert column order. Useful when inverting PCB texts in PCB Print.
+-  ``row_spacing`` :index:`: <pair: preflight - include_table - include_table - outputs; row_spacing>` [:ref:`number <number>`] (default: ``2``) Space (in number of characters) between rows.
+-  ``text_alignment`` :index:`: <pair: preflight - include_table - include_table - outputs; text_alignment>` [:ref:`string <string>`] (default: ``'left'``) (choices: "left", "center", "right") Text alignment in the table.
+-  ``top_rule_width`` :index:`: <pair: preflight - include_table - include_table - outputs; top_rule_width>` [:ref:`number <number>`] (default: ``0.4``) Width of top rule (above header). Use 0 to eliminate it.
+-  ``vertical_rule_width`` :index:`: <pair: preflight - include_table - include_table - outputs; vertical_rule_width>` [:ref:`number <number>`] (default: ``0.1``) Width of vertical rules between columns. Use 0 to eliminate it.
+

docs/source/configuration/preflights/IncludeTableOptions.rst

@@ -0,0 +1,17 @@
+.. _IncludeTableOptions:
+
+
+IncludeTableOptions parameters
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+-  **outputs** :index:`: <pair: preflight - include_table - include_table; outputs>`  [:ref:`IncTableOutputOptions parameters <IncTableOutputOptions>`] [:ref:`list(dict) <list(dict)>` | :ref:`list(string) <list(string)>` | :ref:`string <string>`] (default: ``[]``) List of CSV-generating outputs.
+-  ``enabled`` :index:`: <pair: preflight - include_table - include_table; enabled>` [:ref:`boolean <boolean>`] (default: ``true``) Enable the check. This is the replacement for the boolean value.
+-  ``group_name`` :index:`: <pair: preflight - include_table - include_table; group_name>` [:ref:`string <string>`] (default: ``'kibot_table'``) Name for the group containing the table. The name of the group
+   should be <group_name>_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

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:`: <pair: preflight - include_table; include_table>`  [:ref:`IncludeTableOptions parameters <IncludeTableOptions>`] [:ref:`boolean <boolean>` | :ref:`dict <dict>`] (default: ``false``) Use a boolean for simple cases or fine-tune its behavior.
+
+.. toctree::
+   :caption: Used dicts
+
+   IncludeTableOptions