2016-08-15 6 views
0

私はSphinxバージョン1.4.5を使用しています。スフィンクスの文書作成時にモジュールをインポートできませんでした

マイプロジェクトの構造は以下の通りです:

+ src > main.py + docs (generated with sphinx-quickstart)

でもdocs/conf.pysrcフォルダへのパスを追加した後:

sys.path.insert(0, os.path.abspath('../src')) 

そしてsrc/main.pyのための最初のファイルを生成する(すなわちdocs/src.rstdocs/modules.rst):

私は html Webページを構築しようとすると

$ make clean 
$ make html 

それはsrcモジュールとsrc/main.py両方見つけることができませんでした:

WARNING: autodoc: failed to import module u'src.main'; the following exception was raised

+0

現在の作業ディレクトリは何ですか?それは 'docs'ですか? –

+0

いいえ、それは 'src'と' docs'(プロジェクトフォルダ)の親です。 – h4k1m

答えて

2

ではなく、あなたのパス挿入のためにこれをやってみてください。

sys.path.insert(0, os.path.abspath('../')) 

はまたsrcよりも、自分のディレクトリのためのより良い名前を考えます。

+0

'conf.py'は' docs'フォルダの中に直接生成されました。 'src'の代わりに何を使用することをお勧めしますか? – h4k1m

+1

'conf.py'が' docs'の中にある場合は、私が試してみるべきことについて私の更新を見てください。 wrtディレクトリの名前は、ソースディレクトリの名前をプロジェクトと同じにするのが一般的です。プロジェクトの名前がFoobarの場合は、 'src'の代わりに' foobar'というディレクトリがあります。 – Plasma

0

をあなたの現在の作業ディレクトリはディレクトリでなければなりませんあなたのメイクファイルのサイズはdocsです。

+1

作業ディレクトリではどういう意味ですか?私は 'sphinx-apidoc'と' make'を実行するディレクトリを意味しますか? – h4k1m

関連する問題