文档字符串代码块在 spyder 中未正确显示
docstring codeblock not showing properly in spyder
我正在尝试为我编写的 python 模块创建示例代码块,根据 here spyder 使用 sphinx 在帮助 window 中呈现文档字符串.当我尝试使用以下代码创建代码块时:
'''
Example:
---------
.. code-block :: python
::
def testing():
pass
'''
下面是呈现的内容:
testing(): ...
应该在突出显示的块内。我不知道如何解决这个问题...任何帮助将不胜感激!
所以事实证明(经过大量摆弄之后)需要 ::
下的空行:
'''
Example:
---------
::
def testing():
pass
'''
正确渲染,
似乎 .. code-block :: python
也引起了一些问题,我不确定为什么。
我正在尝试为我编写的 python 模块创建示例代码块,根据 here spyder 使用 sphinx 在帮助 window 中呈现文档字符串.当我尝试使用以下代码创建代码块时:
'''
Example:
---------
.. code-block :: python
::
def testing():
pass
'''
下面是呈现的内容:
testing(): ...
应该在突出显示的块内。我不知道如何解决这个问题...任何帮助将不胜感激!
所以事实证明(经过大量摆弄之后)需要 ::
下的空行:
'''
Example:
---------
::
def testing():
pass
'''
正确渲染,
似乎 .. code-block :: python
也引起了一些问题,我不确定为什么。