覆盖spdoc的autodoc中__getitem__的默认签名

Question

我有一个支持下标的Foo类，因此，如果foo是Foo的实例，则foo [12]将找到第12个。 Foo定义如下：

class Foo:
    def __getitem__(self, i):
        """Get the ith element of self."""
        ....

sphinx rst文件看起来像这样：

.. autoclass:: Foo
    :members: __getitem__, ...

当sphinx构建文档时，Foo的实现下标的__getitem__成员函数记录为：

  

__ getitem __ （i）

     

获取Foo的第ith个元素。

但是，对于不了解Python dunder函数并且不知道下标括号是由__getitem__定义的文档的读者，该函数签名会感到困惑。最好像这样记录__getitem__：

  

foo [i]

     

获取Foo foo的第ith个元素。

是否有一种方法可以用foo[i]覆盖成员函数签名，而后者看起来根本不像签名？