擅长:python、mysql、java
<p>在找到这个问题后,我解决了以下问题,这是一个有效的狮身人面像,工作得相当好:</p>
<pre><code>def some_function(first, second="two", **kwargs):
r"""Fetches and returns this thing
:param first:
The first parameter
:type first: ``int``
:param second:
The second parameter
:type second: ``str``
:param \**kwargs:
See below
:Keyword Arguments:
* *extra* (``list``) --
Extra stuff
* *supplement* (``dict``) --
Additional content
"""
</code></pre>
<p>需要<code>r"""..."""</code>才能使其成为“原始”docstring,从而保持<code>\*</code>的完整性(Sphinx将其作为文本<code>*</code>,而不是“emphasis”的开头)。</p>
<p>所选择的格式(带括号类型的项目符号列表和m-dash分隔的描述)只是为了与Sphinx提供的自动格式匹配。</p>
<p>一旦你努力使“关键字参数”部分看起来像默认的“参数”部分,似乎从一开始滚动你自己的参数部分会更容易(根据其他一些答案),但作为概念的证明,如果您已经在使用Sphinx,这是一种很好地寻找补充<code>**kwargs</code>的方法。</p>