Skip to content

Latest commit

 

History

History
150 lines (113 loc) · 3.32 KB

tables.rst

File metadata and controls

150 lines (113 loc) · 3.32 KB
Raw

Tables

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#tables

Grid Tables

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#grid-tables

+------------------------+------------+----------+----------+ | Header row, column 1 | Header 2 | Header 3 | Header 4 | | (header rows optional) | | | | +========================+============+==========+==========+ | body row 1, column 1 | column 2 | column 3 | column 4 | +------------------------+------------+----------+----------+ | body row 2 | Cells may span columns. | +------------------------+------------+---------------------+ | body row 3 | Cells may | - Table cells | +------------------------+ span rows. | - contain | | body row 4 | | - body elements. | +------------------------+------------+---------------------+

Simple Tables

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#simple-tables

A B A and B
False False False
True False False
False True False
True True True

With column spans:

Inputs Output

A B

 A or B
===== ===== ======
False False False
True False True
False True True
True True True

With more complicated stuff:

col 1 col 2
1 Second column of row 1.

2

Second column of row 2. Second line of paragraph.

3
  • Second column of row 3.
  • Second item in bullet list (row 3, column 2).
Row 4; column 1 will be empty.

5

Second column of row 5.

  • Bullet

Text after bullet.

6

Numbered list:

  1. item

Adjacent tables (is there a vertical space between them?):

col 1 col 2
col 1 col 2

CSV Tables

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

Frozen Delights!
Treat Quantity Description
Albatross 2.99 On a stick!
Crunchy Frog 1.49 If we took the bones out, it wouldn't be crunchy, now would it?
Gannet Ripple 1.99 On a stick!

List Tables

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

Frozen Delights!
Treat Quantity Description
Albatross 2.99 On a stick!
Crunchy Frog 1.49 If we took the bones out, it wouldn't be crunchy, now would it?
Gannet Ripple 1.99 On a stick!

Nesting

Table in admonition

Header with code

Text with code

Table in topic

Header with code

Text with code

Table in sidebar

Header with code

Text with code