如何将突出显示或代码块插入 Sphinx 样式的文档字符串中？

Question

例如：

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

不产生所需的输出（它逐字打印单词 "highlight" 并且不以任何特殊方式格式化以下代码）。 code-block.

也是如此

我尝试了不同的缩进等。无论如何，生成器成功，但输出结果大致相同。

Answer 1

将您的代码与 docs 进行比较，您缺少缩进以及突出显示和实际代码之间的空行。应该是这样的：

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

        import sys
        ...
    '''

How do I insert highlight or code-block into Sphinx-style docstrings?