表格#
1. Markdown 语法#
表格可以使用标准的 Github Flavoured Markdown 语法 编写:
| foo | bar |
| --- | --- |
| baz | bim |
foo |
bar |
---|---|
baz |
bim |
列中的单元格可以使用 :
字符对齐:
| left | center | right |
| :--- | :----: | ----: |
| a | b | c |
left |
center |
right |
---|---|---|
a |
b |
c |
在 Sphinx HTML 主题中对齐单元格
通过将 text-left
、text-center
或 text-right
分配给单元格来对齐文本。然后,你使用的主题需要包含适当的 CSS 样式。
<table class="colwidths-auto table">
<thead>
<tr><th class="text-left head"><p>left</p></th></tr>
</thead>
<tbody>
<tr><td class="text-left"><p>a</p></td></tr>
</tbody>
</table>
3. 列表表格#
list-table
指令用于从统一的两级项目列表中创建表格。“统一” 意味着每个子列表(第二级列表)必须包含相同数量的列表项。
:::{list-table} Frozen Delights!
:widths: 15 10 30
:header-rows: 1
* - 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!
:::
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! |
以下选项被识别:
列表表格选项
align
: “left”, “center”, 或者 “right”表格的水平对齐方式。
header-rows
: integer用于表格标题中的列表数据的行数。默认为0。
stub-columns
: 整数用作 stubs(左侧的行标题)的表格列数。默认为0。
width
: length 或者 percentage将表格的宽度设置为指定的长度或行宽的百分比。
如果省略,渲染器将根据表格内容或列宽确定表格宽度。
widths
:整数[整数...]
或 “auto”一组相对列宽的列表。默认情况下,各列宽度相等 (100%/#columns)。
“auto” 将列宽的确定委托给输出构建器处理。
class
一组以空格分隔的 CSS 类,用于添加到表格中。
name
用于警告的引用目标(参见交叉引用)。
4. CSV 表格#
csv-table
指令用于从逗号分隔值(CSV)数据中创建表格。
```{csv-table} Frozen Delights!
:header: >
: "Treat", "Quantity", "Description"
:widths: 15, 10, 30
"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!"
```
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! |
以下选项被识别:
CSV 表格选项
align
: “left”, “center”, 或者 “right”表格的水平对齐方式。
delim
: char | “tab” | “space”用于分隔字段的单字符字符串。默认为 , (逗号)。可以指定为 Unicode 码点;有关语法详情,请参见 unicode 指令。
encoding
: 字符串外部 CSV 数据(文件或 URL)的文本编码。默认为文档的输入编码。
escape
: char用于转义分隔符或引号字符的单字符字符串。可以指定为 Unicode 码点;有关语法详情,请参见 unicode 指令。当分隔符用于未加引号的字段中,或当引号字符用于字段内时使用。默认情况下是重复该字符,例如:“He said, ““Hi!”””
file
:字符串(换行符已移除)CSV 数据文件在本地文件系统中的路径。
header
: CSV 数据表格标题的补充数据,独立于主 CSV 数据中的任何标题行之前添加。必须使用与主 CSV 数据相同的 CSV 格式。
header-rows
: integer用于表格标题的 CSV 数据的行数。默认为0。
keepspace
: flag将紧跟在分隔符后的空白视为有效。默认情况下会忽略此类空白。
quote
: char用于引用包含分隔符或以引号字符开头的元素的单字符字符串。默认为 " (引号)。可以指定为 Unicode 码点;有关语法详情,请参见 unicode 指令。
stub-columns
: 整数用作 stubs(左侧的行标题)的表格列数。默认为0。
url
:字符串(空白已移除)指向 CSV 数据文件的互联网 URL 引用。
widths
:整数、[整数...]
或 “auto”一组相对列宽的列表。默认情况下,各列宽度相等 (100%/#columns)。
“auto” 将列宽的确定委托给后端渲染器处理。
width
: length 或者 percentage将表格的宽度设置为指定的长度或行宽的百分比。如果省略,渲染器将根据表格内容或列宽来确定表格宽度。
class
一组以空格分隔的 CSS 类,用于添加到表格中。
name
用于警告的引用目标(参见交叉引用)。