如何在Sphinx风格的文档字符串中插入高亮或代码块？

Question

例如：

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

不会产生所需的输出（它打印单词＆＃34;突出显示＆＃34;逐字，并且不以任何特殊方式格式化以下代码）。同样适用于code-block。

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

Answer 1

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

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

        import sys
        ...
    '''