Задокументируйте два приложения Python с похожей структурой, используя sphinx. ⇐ Python
-
Anonymous
Задокументируйте два приложения Python с похожей структурой, используя sphinx.
Структура папок выглядит следующим образом:
|- доб. | | - приложение.py | | - Extensions.py (создает экземпляр БД) | | - модели/ (содержащие модели sqlalchemy) | | - маршруты/ (содержащие файлы конечных точек) |- услуги | | - приложение.py | | - Extensions.py (создает экземпляр БД) | | - модели/ (содержащие модели sqlalchemy) | | - маршруты/ (содержащие файлы конечных точек) |- документы | | [данные сфинкса] Оба приложения flask принадлежат одному проекту, но не могут быть объединены. Обычно я бы просто расширил путь в sphinx conf.py следующим образом:
sys.path.append(os.path.join(up(up(os.path.dirname(__file__))), "сервер", "службы"))
Но когда я использую это, я могу получить доступ только к методам маршрутов services или ext.
.. automodule::routes.auth :члены: :undoc-members: Если я добавлю путь только на один каталог выше, вот так:
sys.path.append(os.path.join(up(up(os.path.dirname(__file__))), "server"))
и попробуйте импортировать модуль следующим образом:
.. automodule::services.routes.auth :члены: :undoc-members: Я получаю сообщение об ошибке
ВНИМАНИЕ: autodoc: не удалось импортировать модуль «auth» из модуля «services.routes»; было создано следующее исключение: Нет модуля с именем «расширения». при попытке создать документ.
Каким будет правильное решение проблемы?
Структура папок выглядит следующим образом:
|- доб. | | - приложение.py | | - Extensions.py (создает экземпляр БД) | | - модели/ (содержащие модели sqlalchemy) | | - маршруты/ (содержащие файлы конечных точек) |- услуги | | - приложение.py | | - Extensions.py (создает экземпляр БД) | | - модели/ (содержащие модели sqlalchemy) | | - маршруты/ (содержащие файлы конечных точек) |- документы | | [данные сфинкса] Оба приложения flask принадлежат одному проекту, но не могут быть объединены. Обычно я бы просто расширил путь в sphinx conf.py следующим образом:
sys.path.append(os.path.join(up(up(os.path.dirname(__file__))), "сервер", "службы"))
Но когда я использую это, я могу получить доступ только к методам маршрутов services или ext.
.. automodule::routes.auth :члены: :undoc-members: Если я добавлю путь только на один каталог выше, вот так:
sys.path.append(os.path.join(up(up(os.path.dirname(__file__))), "server"))
и попробуйте импортировать модуль следующим образом:
.. automodule::services.routes.auth :члены: :undoc-members: Я получаю сообщение об ошибке
ВНИМАНИЕ: autodoc: не удалось импортировать модуль «auth» из модуля «services.routes»; было создано следующее исключение: Нет модуля с именем «расширения». при попытке создать документ.
Каким будет правильное решение проблемы?
Мобильная версия