代码之家  ›  专栏  ›  技术社区  ›  oarfish

如何在sphinx中记录“function”类型的参数?

  •  1
  • oarfish  · 技术社区  · 7 年前

    我有一个这样的文档字符串:

    '''
    Attributes
    ----------
    _forward_fn  :  function
                    Blabla...
    ''' 
    

    但斯芬克斯不接受这种类型,并抱怨

    :py:class reference target not found: function
    

    尽管Python在查询 type() 指用户定义的函数。我试过了 callable , Function , Callable 也没用。Python文档的清单中似乎没有这种类型,所以我想我运气不好 唯一的解决方案是将类型添加到 nitpick_ignore 在里面 conf.py ?

    0 回复  |  直到 7 年前