Sphinx autodo c расширение для python> 3.5 строк документации не работает из-за типов аргументов функции - PullRequest
0 голосов
/ 04 февраля 2020

Я пытался заставить autodo c автоматически задокументировать мой python 3.7 модуль. Единственный файл, который мне нужно получить, это файл init .py в одном модуле. Этот файл состоит только из функций и содержит строки документации в формате Sphinx. Все идет нормально. Тем не менее, мои функции имеют свои типы аргументов, такие как:

def func1(filepaths: list):
  ...

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

Это отбрасывает autodo c. Я получаю следующую ошибку:

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

Не поддерживает ли autodo c синтаксический анализ python файлов> python 3.5?

Спасибо

1 Ответ

0 голосов
/ 04 февраля 2020

На самом деле, я думаю, что я нашел ответ на этот вопрос. Оказывается, мой сфинкс использовал python 2.7 пакеты сайтов. Это помогло: Как заставить Sphinx использовать Python 3.x интерпретатор

...