実際のプロジェクトで行う前に、テスト Python プロジェクトのドキュメントを作成しようとしています。私のシステム: Win7 64 ビット、python 2.7.5 64 ビット。
私のプロジェクト名はtestDocです。tという名前の python パッケージが含まれており、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.
どうしたの？ありがとう。