Skip to main content
 首页 » 编程设计

python之如何在 Python 中将作者身份添加到 NumPy 文档字符串

2025年05月04日49pengyingh

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

有没有办法正确地将作者身份添加到 NumPy 文档字符串?

一个简单的例子:

class A: 
    def f(self): 
        """ My function 
 
        It does this and that. 
 
        Returns 
        ------- 
        object 
 
        .. sectionauthor:: name of the author 
 
        Examples 
        -------- 
            >>> A().f() 
 
        """ 
        pass 

编译到此帮助文档(注意有问题的返回:部分):

附言在其他地方建议在 NumPy 文档字符串中使用 .. sectionauthor::(不记得来源),所以可能只是没有正确使用/放置它。

请您参考如下方法:

想通了...

首先,NumPy style documentation不鼓励将作者信息添加到文档字符串中:“请注意,许可证和作者信息虽然通常包含在源文件中,但不属于文档字符串。”

也就是说,直接在文档中识别作者的情况并不少见(请参阅 R 语言中函数/方法的任何帮助手册)。

不过,如果需要添加作者,可以使用 :Authors: reStructured inline markup 来完成。标签,如下:

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

据发现,它的位置是有限的。 :Authors: 如果远离描述、参数和返回部分,似乎仍能正确呈现文档字符串;例如,在 Examples 部分之后。

这是一个继续的例子: