I am trying to document a Python project with Sphinx, but I'm having trouble combining the autodoc
extension with a namedtuple
generated class.
In one document, gammatone.rst
, I have:
:mod:`gammatone` -- gammatone filterbank toolkit
================================================
.. automodule:: gammatone
:members:
.. automodule:: gammatone.coeffs
:members:
In my gammatone/coeffs.py
, I have:
from collections import namedtuple
ERBFilterCoeffs = namedtuple(
'ERBFilterCoeffs', # Most parameters omitted
[
'A0',
'gain',
])
The code generated by namedtuple
includes very generic docstrings that Sphinx's autodoc
module picks up and includes. I'd rather document the class properly myself, without forgoing autodoc
for the rest of the module.
I've tried putting something like this just before the class:
"""
.. class:: ERBFilterCoeffs(A0, gain)
:param A0: A0 coefficient
:param gain: Gain coefficient
Magic coefficients.
"""
...but it doesn't show up in the generated docs. Putting it after the class results in it being nested underneath the generic class documentation, rather than replacing it.
How do I simply tell Sphinx (and the autodoc
extension) to use my documentation for the ERBFilterCoeffs
class instead of that generated by namedtuple
?