Я хочу начать документировать свое приложение на основе 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
Программы на Python
-
Anonymous
1730121110
Anonymous
Я хочу начать документировать свое приложение на основе 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:
Подробнее здесь: [url]https://stackoverflow.com/questions/79113846/sphinx-ext-autodoc-modulenotfounderror-for-external-packages[/url]
Ответить
1 сообщение
• Страница 1 из 1
Перейти
- Кемерово-IT
- ↳ Javascript
- ↳ C#
- ↳ JAVA
- ↳ Elasticsearch aggregation
- ↳ Python
- ↳ Php
- ↳ Android
- ↳ Html
- ↳ Jquery
- ↳ C++
- ↳ IOS
- ↳ CSS
- ↳ Excel
- ↳ Linux
- ↳ Apache
- ↳ MySql
- Детский мир
- Для души
- ↳ Музыкальные инструменты даром
- ↳ Печатная продукция даром
- Внешняя красота и здоровье
- ↳ Одежда и обувь для взрослых даром
- ↳ Товары для здоровья
- ↳ Физкультура и спорт
- Техника - даром!
- ↳ Автомобилистам
- ↳ Компьютерная техника
- ↳ Плиты: газовые и электрические
- ↳ Холодильники
- ↳ Стиральные машины
- ↳ Телевизоры
- ↳ Телефоны, смартфоны, плашеты
- ↳ Швейные машинки
- ↳ Прочая электроника и техника
- ↳ Фототехника
- Ремонт и интерьер
- ↳ Стройматериалы, инструмент
- ↳ Мебель и предметы интерьера даром
- ↳ Cантехника
- Другие темы
- ↳ Разное даром
- ↳ Давай меняться!
- ↳ Отдам\возьму за копеечку
- ↳ Работа и подработка в Кемерове
- ↳ Давай с тобой поговорим...
Мобильная версия