2012-01-25 3 views
3
import myModule as myModule 

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

import myPackage.myModule as myModule 

с этим я получаю «Нет модуль с именем myPackage.myModule» не имеет значения, если этот файл существует в корневого каталога или в каталоге myPackage.

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

ответ

9

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

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

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

+0

Что делать, если мой корень проекта - это два каталога вверх, а не один? – Dave

+0

@Dave затем замените '..' на '../ ..' –

+0

@AlexMorega Ваш код действительно помог! Я просто хотел отредактировать свой код, чтобы добавить закрывающую скобку, но мое редактирование - это только один символ, поэтому он не позволит мне. – Will

Смежные вопросы