python - Sphinx はうまくインポートできないコードでも動作しますか?

Question

Sphinx ドキュメンテーション エンジンは、うまくインポートされないプロジェクトのドキュメンテーションを正常に生成しますか? 特に、私のプロジェクトにはエキゾチックな依存関係があります。ドキュメントの生成をこの依存関係に依存させたくありません。

Sphinx はモジュールをインポートしてイントロスペクションを使用する必要がありますか? それとも解析しますか?

Answer 1

autodoc 拡張機能を使用している場合は、プロジェクトがインポート可能である必要があります。ただし、依存関係をモックアウトできる場合もありますconf.py(おそらく、インポート時に依存関係は名前のみで必要になるため)。Read the Docs ドキュメントには、これを行う方法の例があります。