Table Usage

[72757373656c6c]

There are 5 ways to create tables. I am looking at converting tables containing command options, configuration changes, and code snippets. In Sphinx-MyST, I'm leaning towards the eval-rst because I can span columns and rows and they are the closest to hand-drawn tables. The list-table directive is my next choice because a user doesn't have to spend time formatting a table with spaces, dashes, and vertical bars, although the formatted tables are easier to read in the original source markdown documents. It looks like the github format is the only one with cell alignment.

If anyone would like to discuss their usage of working with tables it would be appreciated.

1. Type: github syntax

| Command  | Example   | Note  |
| :-----:  | -------:  | ----  |
| r1 c1    | r1 c2     | r1 c3 |
| r2 c2    |           | r2 c3 |

2. Type: table directive

:::{table} Table caption
:align: center 
:width: 50% 
:widths: 10 10 30 

| Command  | Example   | Note  |
| ------   | --------- | ----- |
| r1 c1    | r1 c2     | r1 c3 |
| r2 c1    |           | r2 c3 |
:::

3. Type: list-table

:::{list-table} Table caption
:align: center
:header-rows: 1
:width: 50%

* - Command
  - Example
  - Note
* - r1 c1
  - r1 c2
  - r1 c3
* - r2 c1
  -
  - r2 c3
:::

4. Type: csv

:::{csv-table} Table caption
:align: center
:delim: ","
:header: >
:  "Command", "Example", "Note"
:widths: 30, 5, 5

r1 c1, r1 c2, r1 c3
r2 c1, , r2 c3
:::

5. Type: restructured text grid table. See MyST-Parser #226

```{eval-rst}
+------------+------------+-----------+
| Command    | Example    | Note      |
+============+============+===========+
| r1 c1      | r1 c2      | r1 c3     |
+------------+------------+-----------+
| r2 c1      | Cells may span columns |
+------------+------------+-----------+
| r3 c1      | Cells may  | - Cells   |
+------------+ span rows  | - contain |
| r4 c1      |            | - blocks  |
+------------+------------+-----------+
```

Note

You cannot use the colon code fence with eval-rst.