Sphinx文档如何包含来自另一个文档字符串的信息

时间:2019-02-06 22:43:20

标签: python documentation python-sphinx sphinx-napoleon

嗨,我在类方法中有一个别名(我不知道这是否是技术术语)的函数,如下所示:

def foo(p_1,p_2):
    """this foos the bar
    Long detailed docsting
    """
   return p_1+p_2

class bar():
    def foo(self, p_2):
        """this also foos the bar
        But I don't want to copy the whole docstring
        """
        return foo(self.p_1,p_2)

我希望sphinx autodoc(与napoleon一起)在方法文档中包含来自函数文档字符串的很多信息。似乎应该有一种简单的方法可以做到这一点,但我不知道。

0 个答案:

没有答案