如何在Python中为NumPy docstring添加作者身份

Question

我们从Sphinx切换到样式NumPy文档字符串，而.. sectionauthor::似乎不再正确呈现。然而，我们需要能够为一个类的每个方法分配一个作者。

有没有办法正确添加NumPy docstring的作者身份？

一个天真的例子：

class A:
    def f(self):
        """ My function

        It does this and that.

        Returns
        -------
        object

        .. sectionauthor:: name of the author

        Examples
        --------
            >>> A().f()

        """
        pass

编译到此帮助文档中（通知问题返回部分）：

P.S。在其他地方建议在NumPy文档字符串中使用.. sectionauthor::（无法回忆起来源），因此可能没有正确使用/放置。

Answer 1

想通了......

首先，NumPy style documentation不鼓励添加作者和＃39; info to docstring：＆＃34; 请注意，许可证和作者信息虽然通常包含在源文件中，但不属于文档字符串。＆＃34;

也就是说，直接在文档中识别作者并不罕见（参见R语言中的函数/方法的任何帮助手册）。

但是，是否需要添加作者，这可以使用:Authors: reStructured inline markup标记完成，如下所示：

:Authors:
    John Doe <John.Doe@email.com>

如发现，其位置有限。 :Authors:似乎仍然正确呈现文档字符串，如果远离描述，参数和返回部分;例如，在Examples部分之后。

这是一个继续的例子：