【发布时间】:2014-05-27 22:31:15
【问题描述】:
我正在尝试使用 Sphinx 记录我的 Python 3 代码。这是我的示例文件:
class MyClass:
"""
Class description
"""
def get_name(self) -> str:
"""
Returns the name of this object as a string.
"""
return "Jim"
我在一个 .rst 文件中的指令是:
.. autoclass:: my_class.MyClass
:members:
但是当我运行sphinx-build -b html -d _build/doctrees . _build/html(版本1.1.3)时,类型注释->会中断:
def command_name(self) -> str:
^
SyntaxError: invalid syntax
如何让 Sphinx 识别类型注释?
编辑:我的 python3 版本是 3.2.3。
【问题讨论】:
-
如果可能,我想避免扩展。此外,该模块需要 3.3+。
-
从文档看来你需要扩展来做你想做的事。我不认为升级到 python 3.4 会受到伤害。
标签: python python-sphinx