相关疑难解决方法(0)

所以我正在尝试创建一个"动态"文档字符串,如下所示:

ANIMAL_TYPES = ["mammals", "reptiles", "other"]

def func(animalType):
""" This is a sample function.

    @param animalType: "It takes one of these animal types %s" % ANIMAL_TYPES
"""

基本上让文档字符串@param animalType显示任何ANIMAL_TYPES有; 这样当更新此变量时,docstring将自动更新.

然而不幸的是,它似乎没有用......有谁知道是否有办法实现这一目标？

假设我有一堂课

class A(object):
  def myfunction():
    """A."""
    pass

和一个子类

class B(A):
  def myfunction():
    pass

是否可以使用sphinx从A.myfunction继承B.myfunction的API文档？B.myfunction的文档应为"A".同样.