python – Sphinx:将代码段放在无序列表项的第一行
作者:互联网
我正在使用Sphinx来管理我的项目文档.
我有一个无序列表,我希望每个项目的第一行是一个代码段. (不是内联,一段.)
我怎样才能做到这一点?
解决方法:
看看我自己的文档,我发现了一个类似的场景,但是我不能保证它可以作为列表中的第一个文本使用文档:
#. **Defining the Model Class**
All models must inherit from |LrbBaseModel| either directly or
indirectly and have the |LrbModelInit| decorator above their
constructor (a.k.a. ``__init__``)::
class foo(LrbBaseModel):
@LrbModelInit()
def __init__(self):
...
这会产生:
我认为你可以使用没有pre-amble文本的代码块,如下所示:
#. ::
def fooDeFaFa():
pass
请注意,我的代码块缩进了两次. ::表示空的文本段落块,然后我的代码是第一次缩进的这个:: syntax的子代.
或者,这可能有效:
#.
::
def fooDeFaFa():
pass
标签:python,python-sphinx,restructuredtext 来源: https://codeday.me/bug/20190705/1382909.html