python - Sphinx 文档在字段中显示双冒号

Question

我正在为一个包开发文档，当我构建 sphinx 文档时，我得到了双冒号

针对每个函数定义的所有字段。

我为我的文档字符串使用了 numpydoc 样式，并且这些文档中没有冒号来指示它们可能来自哪里:

    """

    Function description

    Parameters
    -----------
    param1: str or list
        A description for the parameter

    Returns
    -----------
    Dictionary
        Some info about what is returned

    Examples
    -----------
        >>> output = somefunction(param1)

    """

有没有人遇到过这个？值得注意的是，这不会发生在 Examples 字段中。只是 Parameters、Returns 和 Return Type。

Answer 1

我在使用 Sphinx 5.0.2 时遇到了同样的问题。检查 HTML 文件时，看起来 CSS 规则添加分号 (::after) 使用:

dl.field-list > dt:after {
    content: ":";
}

我通过在 custom css style 中覆盖此规则摆脱了这种行为工作表:

dl.field-list > dt:after {
    content: "";
}

这显然不是最好的解决方案，但它为我完成了工作。