restructuredText の表のセルの中で改行する

はじめに

restructuredText にはいろいろな表の書き方がありますが、セル内改行方法について意外とまとまったものがなかったので記します。

確認

VS Code の ReStructured Text Previewer v2.0.0 で確認しました。

Grid Table 編

先頭に "|" をつける。

参考

+----------+----------+----------+
| Header 1 | Header 2 | Header 3 |
+==========+==========+==========+
| | Item 1 |          |          |
| | Item 2 |          |          |
+----------+----------+----------+

Simple Table 編

先頭に "|" をつける。ただし１列目はできないかもしれません。

======== ======== ========
Header 1 Header 2 Header 3
-------- -------- --------
Item 1   | Item 2
         | Item 3
======== ======== ========

list-table 編

先頭に "|" をつける。"|" の位置を合わせないとエラーになります。

.. list-table:: TheListTable
    :header-rows: 1
    :widths: 10, 10, 10

    * - Header 1
      - Header 2
      - Header 3
    * - | Item1
        | Item2
      - Item3
      - Item4
    * - Item5
      - Item6
      - Item7

または改行を二つ続ける。厳密には改行ではなく改「段落」ですが。

.. list-table:: TheListTable
    :header-rows: 1
    :widths: 10, 10, 10

    * - Header 1
      - Header 2
      - Header 3
    * - Item1

        Item2
      -
      -

csv-table 編

ダブルクォートでくくって "|" を付ける。

"|" を記述する位置に注意してください。最初の "|" と揃えるのではなく、最初のダブルクォートと揃えるようです。

参考

.. csv-table:: TheCsvTable
    :header: Header 1, Header 2, Header 3
    :widths: 10, 10, 10
    
    "| Item 1
    | Item 2",Item 3,Item 4

Pythonプロフェッショナルプログラミング 第2版

アイドルマスター＼THE IDOLM@STER シンデレラガールズ 依田芳乃[はるべと咲くや]+ 1/7 完成品フィギュア