Note

This version of the guide covers the new PHP-based rendering of Documentation with the TYPO3 Documentation theme.

If the project you are looking at has a file Documentation/guides.xml it is using the new rendering.

Otherwise, consider to migrate the Documentation or head over to the legacy version of this guide: How to document, Sphinx based.

Tables

There are several ways to create tables in reST.

It is recommended that you do not use large tables as they are not responsive.

Grid table

+----------+----------+
| Header 1 | Header 2 |
+==========+==========+
| 1        | one      |
+----------+----------+
| 2        | two      |
+----------+----------+

Header 1	Header 2
1	one
2	two

http://docutils.sourceforge.net/docs/user/rst/quickref.html#tables

You can use this table generator to create a grid table.

Simple table

========  ========
Header 1  Header 2
========  ========
1         one
2         two
========  ========

Header 1	Header 2
1	one
2	two

http://docutils.sourceforge.net/docs/user/rst/quickref.html#tables

CSV table

..  csv-table:: Numbers
    :header: "Header 1", "Header 2"
    :widths: 15, 15

    1, "one"
    2, "two"

Header 1	Header 2
1	one
2	two

https://docutils.sourceforge.io/docs/ref/rst/directives.html#csv-table-1

t3-field-list-table tables

t3-field-list-table is a custom directive, created by the t3SphinxThemeRtd template. If you want your .rst file to be correctly rendered on other platforms as well (for example GitHub), you should not use this.

..  t3-field-list-table::
    :header-rows: 1

    -   :Header1:   Header1
        :Header2:   Header2

    -   :Header1:   1
        :Header2:   one

    -   :Header1:   2
        :Header2:   two

Header1	Header2
1	one
2	two

Example: https://docs.typo3.org/typo3cms/GuidesAndTutorials/Index.html