2016-08-28 5 views
1

私はsphinx-autodoc-annotationを使用してPythonコードの関数注釈を読み込み、それを使って適切な引数型と返り値を生成します。私のローカルマシンではうまくいっていますが、私はもちろんpip install sphinx-autodoc-annotationでした。どのようにしてsphinx-autodoc-annotationを使用するためにドキュメントを読み込むのですか?

私はRead the Docsを使用して同じドキュメントを生成しようとしているが、それは私にエラーを与える:

Could not import extension sphinx_autodoc_annotation (exception: No module named sphinx_autodoc_annotation) 

それはスフィンクス-autodocのアノテーションで動作するようにドキュメントを読んで、そうであれば設定することは可能です、私はそれを動作させる方法は?

答えて

1

Read the Docsプロジェクトのプロジェクトのインストールオプションを有効にします。

このオプションが有効になっている場合、読者はパッケージにsetup.py installを実行しようとします(RtD docs参照)。 setup.pyには、requirements fileで指定されているパッケージをインストールできます。 例としてsource code of the Flask-MongoRest projectをご覧ください。

requirements.txtファイルに唯一の要件としてsphinx-autodoc-annotationを追加してください。

+0

これは近いですが、まだ完全には機能していません。 'requirements.txt'を' docs'フォルダに追加しました(プロジェクト自体ではなく、ドキュメントをビルドするために必要なだけなので)。RtDの設定で指摘されているように、「setup.pyを使ってvirtualenvの中にプロジェクトをインストールしますインストール"。私はエラーは出ませんが、今は 'py-modindex.html'ファイルを作成することができません。これは、私がSphinxをローカルで実行するときに作成します。私は、これらの追加の詳細すべてを質問に投稿する必要があると思います。 – Chuck

関連する問題