如何为namedtuple（使用autodoc）提供Sphinx文档？

Question

我试图用Sphinx编写一个Python项目，但是在将autodoc扩展与namedtuple生成的类结合起来时遇到了困难。在

在一份文件中，gammatone.rst，我有：

:mod:`gammatone` -- gammatone filterbank toolkit
================================================

.. automodule:: gammatone
   :members:
.. automodule:: gammatone.coeffs
   :members:

在我的gammatone/coeffs.py中，我有：

^{pr2}$

namedtuple生成的代码包含非常通用的docstring，Sphinx的autodoc模块会提取并包含这些docstring。我宁愿自己对类进行适当的文档化，而不放弃模块其余部分的autodoc。在

我试过在课前放这样的东西：

"""
.. class:: ERBFilterCoeffs(A0, gain)
:param A0: A0 coefficient
:param gain: Gain coefficient

Magic coefficients.
"""

…但它不会显示在生成的文档中。将它放在类之后会导致它嵌套在泛型类文档下，而不是替换它。在

如何简单地告诉Sphinx（和autodoc扩展）使用我的文档来处理ERBFilterCoeffs类，而不是{}生成的类？在

Answer 1

在用namedtuple定义ERBFilterCoeffs之后，尝试将该doc字符串分配给ERBFilterCoeffs.__doc__，怎么样？在

编辑：好的，那这个怎么样：

class ERBFilterCoeffs(namedtuple('ERBFilterCoeffs','a b c')):
    """
    this is the doc string for ERBFilterCoeffs
    """