Python 文档字符串 (Sphinx) 中的 csv-table 格式 - 一个单元格中的多行

Question

我正在使用 Sphinx 来记录一个 Python 项目。

似乎与 .. csv-table:: 指令有些不一致。

主要问题是单元格中的新行。还有我可疑的心理健康。

以下代码：

.. csv-table::
    :header: Header1, Header2, Header3

    A, B, "These lines appear as one line, 
    even though they are written in two lines."
    C, D, "| These lines appear as two lines, 
    | but they are indented, and my OCD will simply not allow it."
    E, F, "| If I continue this line in another line,
    it will appear in a new line."
    G, H, "If there is a blank line between the two lines,

    there will be a blank line between the lines."

将呈现为：

我搜索了整个 reStructuredText 手册，但找不到解决方法。

有没有办法在一个单元格中写两行，显示为第二行，但没有缩进？

主题是sphinx_rtd_theme。

我找到了 theme.css 文件 (C:\Python34\Lib\site-packages\sphinx_rtd_theme\static\css\theme.css)，但是我找不到 table 换行样式定义的部分

Answer 1

行块在 sphinx_rtd_theme 中有左边距值。摆脱它们的一种方法是创建一个自定义 CSS 文件，该文件导入主题的样式规则并为表格中没有该边距的行块添加规则。假设一个 Sphinx 项目的标准文件名和路径名：

在您的 Sphinx 项目中创建一个包含以下内容的 _static/css/mystyle.css 文件：

@import "theme.css";

table.docutils div.line-block {
    margin-left: 0;
}

将以下选项添加到 conf.py:

html_style = 'css/mystyle.css'

重建 Sphinx 项目。

Python 文档字符串 (Sphinx) 中的 csv-table 格式 - 一个单元格中的多行

csv-table formatting in Python docstrings (Sphinx) - multiple lines in one cell

python

csv

python-sphinx

restructuredtext

docstring