python - sphinx-autodoc-annotation を使用するように Read the Docs を構成するにはどうすればよいですか?

Question

私はsphinx-autodoc-annotationを使用して Python コードの関数注釈を読み取り、それを使用して適切な予想される引数の型と戻り値の型を生成しています。私のローカルマシンではうまく機能していますがpip install sphinx-autodoc-annotation、もちろんそうしなければなりませんでした。

Read the Docsを使用して同じドキュメントを生成しようとしていますが、エラーが発生します。

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

Read the Docs を sphinx-autodoc-annotation で動作するように構成することはできますか? もしそうなら、どのように動作させるのですか?

Answer 1

Read the Docs プロジェクトの [Install Project] オプションを有効にします。

このオプションが有効になっている場合、Read the Docs はsetup.py installパッケージに対して実行を試みます (参照: RtD docs )。では、要件ファイルsetup.pyで指定されているとおりにパッケージをインストールできます。例として、Flask-MongoRest プロジェクトのソース コードを見てください。

sphinx-autodoc-annotationファイルに唯一の要件として追加しrequirements.txtます。