Python的Sphinx autodoc扩展> 3.5 docstring由于函数参数类型不起作用

问题描述 投票:0回答:1

我一直在尝试使autodoc自动记录我的python 3.7模块。我需要记录的唯一文件是一个模块中的init。py文件。该文件仅包含函数,并且具有Sphinx格式的文档字符串。到目前为止,一切都很好。但是,我的函数有其自变量类型,例如:

def func1(filepaths: list):
  ...

def log_custom_hyperparameter(model, param_name: str, param_value):
  ...

这将取消自动文档。我收到以下错误:

WARNING: autodoc: failed to import module u'<my_module>'; the following exception was raised:
Traceback (most recent call last):
  File "/Users/manjotpahwa/Library/Python/2.7/lib/python/site-packages/sphinx/ext/autodoc/importer.py", line 154, in import_module
    __import__(modname)
  File "/Users/manjotpahwa/<path to file>/__init__.py", line 9
    def log_code_files(filepaths: list):
                                ^
SyntaxError: invalid syntax

autodoc不支持解析python文件> python 3.5吗?

谢谢

python python-sphinx read-the-docs
1个回答
0
投票

实际上,我想我已经找到了这个问题的答案。原来我的狮身人面像使用的是python 2.7网站包。这有助于:How to force Sphinx to use Python 3.x interpreter

© www.soinside.com 2019 - 2024. All rights reserved.