web-dev-qa-db-ja.com

Autodocを使用しているときにSphinxがPythonパッケージを検出しない

実際のプロジェクトで実行する前に、テストPythonプロジェクトのドキュメントを作成しようとしています。私のシステム：Win7 64ビット、python 2.7.564ビット。

私のプロジェクト名は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.

どうしましたか？ありがとう。

pythonpython-sphinxsphinx-apidoc
16
rok

「testDocへの絶対パス」が何であるかはわかりませんが、Sphinxの出力から、testDocのディレクトリ構造がtestDoc/t/docsであることがわかります。 docsディレクトリは、conf.pyがある場所です。

モジュール検索パスを正しく設定するには、conf.pyから2レベル上に移動する必要があります。

sys.path.insert(0, os.path.abspath("../.."))
22
mzjn