Я хочу начать документировать свое приложение на основе Flask с помощью Sphinx. В настоящее время я пытаюсь понять, как использовать расширение autodoc. Все мои локальные модули найдены, но импорт внешних библиотек не работает в sphinx.
Все мои требования записаны в файле require.txt, поэтому я надеюсь, что sphinx может извлечь оттуда пакеты/модули. Я тестирую сфинкса на своей локальной машине в среде. Поэтому я уже добавил:
import os
import sys
sys.path.insert(0, os.path.abspath('../../'))
sys.path.insert(0, os.path.abspath('~/envs'))
в myproject/docs/source/config.py. Это сработало для внутренних модулей моего проекта, но не более того.
Итак, запуск sphinx-build -M html docs/source/docs/build/ вызывает эту ошибку:
WARNING: Failed to import myproject.errors.
Possible hints:
* ModuleNotFoundError: No module named 'flask'
* KeyError: 'myproject'
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] api
WARNING: autodoc: failed to import module 'errors' from module 'myproject'; the following exception was raised:
No module named 'flask' [autodoc.import_object]
Как mwe я создал myproject/docs/source/api.rst:
API
===
.. autosummary::
:toctree: generated
.. automodule:: myproject.errors
:members:
:imported-members:
Подробнее здесь: https://stackoverflow.com/questions/791 ... l-packages
Sphinx.ext.autodoc: ModuleNotFoundError для внешних пакетов ⇐ Python
-
- Похожие темы
- Ответы
- Просмотры
- Последнее сообщение
-
-
Sphinx autodoc — пропуск элементов с установленным автоматическим методом
Anonymous » » в форуме Python - 0 Ответы
- 16 Просмотры
-
Последнее сообщение Anonymous
-