pandas文档如何实现“'参数'和'返回'字段的灰色突出显示”?

时间:2017-06-28 15:35:23

标签: python pandas documentation python-sphinx sphinx-napoleon

查看以下code from github我可以看到使其成为可能的CSS:

 /* grey highlighting of 'parameter' and 'returns' field */
table.field-list {
    border-collapse: separate;
    border-spacing: 10px;
    margin-left: 1px;
    /* border-left: 5px solid rgb(238, 238, 238) !important; */
}

然而,当我尝试在库中实现它时,我写的是无法让它工作。

我已确保将extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']添加到conf.py,以便可以解析numpy样式的docstring。

当Sphinx编译以下代码时:

def test(self, arg1, arg2='test'):
    """
    This is a test function
    Parameters
    ----------
    arg1 : str
        First argument is a string
    arg2 : str
        Second argument is a string
    Returns
    -------
    bool
    """
    return True

生成以下内容

enter image description here

如何生成pandas文档中的'参数'和'返回'字段的灰色突出显示?

0 个答案:

没有答案