带Mypy类型注释的Sphinx autodoc

时间:2018-11-21 08:21:19

标签: python python-sphinx mypy autodoc

目前,我有一些使用mypy类型注释的代码,如下所示:

def translate(self, text, mark_unknown=False, format=None, deformat='txt', reformat='txt'):
    # type: (Translator, str, bool, Optional[str], str, str) -> str

我想用Sphinx的autodoc扩展名对其进行记录,但是看来autodoc当前无法识别这些注释,因此这些注释不会显示在生成的文档中。

有没有简单的解决方法,例如另一个扩展名或autodoc选项,还是我必须写一个带有相关信息的实际docstring?

0 个答案:

没有答案