<p>假设我有一个记录在<a href="https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt">Numpydoc style</a>中的函数,并且文档是用<a href="http://sphinx-doc.org/">Sphinx</a><a href="http://sphinx-doc.org/ext/autodoc.html#directive-autofunction">autofunction directive</a>自动生成的:</p>
<pre><code>def foo(x, y, _hidden_argument=None):
"""
Foo a bar.
Parameters
----------
x: str
The first argument to foo.
y: str
The second argument to foo.
Returns
-------
The barred foo.
"""
if _hidden_argument:
_end_users_shouldnt_call_this_function(x, y)
return x + y
</code></pre>
<p>我不想将隐藏的参数作为我的公共API的一部分进行宣传,但是它会在我自动生成的文档中显示出来。有没有什么方法可以告诉Sphinx忽略函数的某个特定参数,或者(更好)让它自动忽略带有前导下划线的参数?在</p>