代码之家 › 专栏 › 技术社区 › wvxvw

如何将突出显示或代码块插入到Sphinx样式的docstring中?

docstring python-sphinx python

10

wvxvw · 技术社区 · 7 年前

例如:

def foo():
    '''
    .. highlight:: python
    import sys
    '''

不会产生所需的输出(它逐字打印单词“highlight”,并且不会以任何特殊方式格式化以下代码)。同样的情况也发生在 code-block .

我尝试了不同的缩进等。不管怎样,生成器成功地获得了大致相同的输出,但不是所需的输出。

1 回复 | 直到 4 年前

1

20

Chen A. 7 年前

将代码与 docs ,在突出显示和实际代码之间缺少缩进和空行。应该是这样的:

def foo():
    '''
    .. highlight:: python
    .. code-block:: python

        import sys
        ...
    '''

推荐文章

moink · 关于模块长度推理和DocString与代码行之比的Pylint消息

7 年前

jon_two · 当docstring需要字符串时,可以传递None参数吗?

7 年前

Brad Solomon kartick shaw · 在类方法docstrings中使用字符串格式

7 年前

Ray Brian Agnew · Python ReST文档字符串中是否有类似C#'s“see cref”的内容?

7 年前

Jimmy C · 为什么我不能对docstring使用format函数?

10 年前

Paul H · 如何获取脚本中的对象列表,以便在每个对象上打印__doc__?

10 年前