Я пытаюсь создать документацию для тестового проекта Python, прежде чем делать это для реального проекта. Моя система: Win7 64 бит, python 2.7.5 64 бит.
Мое имя проекта testDoc. Он включает в себя python pakage с именем t, который включает в себя 2 модуля t1 и t2 и __init__.py.
__init__.py содержит:
import t1
import t2
t1.py содержит:
'''
Created on 27 2013
@author:
'''
class MyClass(object):
'''
Hi
'''
def __init__(self,selfparams):
'''
Constructor
'''
pass
Чтобы создать документы, я запускаю в командной строке testDoc:
sphinx-apidoc -A "me" -F -o docs .
Sphinx создает много файлов, и это нормально в соответствии с документами Sphinx. Затем изменяется conf.py
sys.path.insert(0, os.path.abspath(absolute path to testDoc))
Я вхожу в папку docs и печатаю
make html
и получите следующий ошибочный вывод:
Making output directory...
Running Sphinx v1.1.3
loading pickled environment... not yet created
building [html]: targets for 2 source files that are out of date
updating environment: 2 added, 0 changed, 0 removed
reading sources... [ 50%] index
reading sources... [100%] t
Traceback (most recent call last):
File "C:\Python27\lib\site-packages\sphinx\ext\autodoc.py", line 321, in impor
t_object
__import__(self.modname)
ImportError: No module named t.__init__
Traceback (most recent call last):
File "C:\Python27\lib\site-packages\sphinx\ext\autodoc.py", line 321, in impor
t_object
__import__(self.modname)
ImportError: No module named t.t1
Traceback (most recent call last):
File "C:\Python27\lib\site-packages\sphinx\ext\autodoc.py", line 321, in impor
t_object
__import__(self.modname)
ImportError: No module named t.t2
...testDoc\t\docs\t.rst:7: WARNING: a
autodoc can't import/find module 't.__init__', it reported error: "No module name
d t.__init__", please check your spelling and sys.path
...testDoc\t\docs\t.rst:15: WARNING:
autodoc can't import/find module 't.t1', it reported error: "No module named t.t
1", please check your spelling and sys.path
t...testDoc\t\docs\t.rst:23: WARNING:
autodoc can't import/find module 't.t2', it reported error: "No module named t.t
2", please check your spelling and sys.path
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 50%] index
writing output... [100%] t
writing additional files... (0 module code pages) genindex search
copying static files... done
dumping search index... done
dumping object inventory... done
build succeeded, 3 warnings.
Build finished. The HTML pages are in _build/html.
Что случилось? Спасибо.
Я не знаю, что такое "абсолютный путь к testDoc", но из вывода Sphinx я вижу, что структура каталогов testDoc testDoc/t/docs. В каталоге docs находится conf.py.
Чтобы путь поиска модуля был правильно настроен, вам нужно перейти на два уровня с conf.py:
sys.path.insert(0, os.path.abspath("../.."))