Как импортировать модуль в Sphinx

import myModule as myModule

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

import myPackage.myModule as myModule

с этим я получаю

Нет модуля с именем myPackage.myModule

Не имеет значения, существует ли этот файл в корневом каталоге или в каталоге myPackage.

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


python python-sphinx
person Meloun    schedule 25.01.2012    source источник

Ответы (1)


arrow_upward
10
arrow_downward

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

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

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

person Alex Morega    schedule 25.01.2012
comment
что, если мой корень проекта находится на два каталога выше, а не на один? - person Dave; 16.11.2012
comment
@ Дэйв, затем замени «..» на «../..» - person Alex Morega; 01.02.2013