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

Question

例如：

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

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

我尝试了不同的缩进等。无论如何，生成器以大致相同的方式成功，但未获得所需的输出。

Answer 1

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

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

        import sys
        ...
    '''