как импортировать модуль в sphinx - PullRequest
4 голосов
/ 25 января 2012
import myModule as myModule

с этим кодом работает импорт, и я могу сделать свой документ

import myPackage.myModule as myModule

с этим, я получаю «Нет модуля с именем myPackage.myModule».каталог.

в RST-файле Я не упомянул про myModule, я хочу документировать другой файл, который просто импортирует этот модуль.

1 Ответ

10 голосов
/ 25 января 2012

Sphinx должен иметь возможность импортировать ваш код, генерировать документацию для классов и функций. Возможно, вам нужно добавить корневую папку вашего проекта в sys.path в Sphinx. Вы можете сделать это из файла Sphinx conf.py:

import sys
import os
sys.path.append(os.path.join(os.path.dirname(__file__), '..'))

Замените '..' относительным путем к корню проекта.

...