0
automodapiを使用して、私のDjangoプロジェクトのドキュメントを生成しようとしています。私はこのようなautomodapiを呼び出すとき:automodapi出力からインポートを除外する方法は?
.. automodapi:: mypackage.mymodule
出力は、関数やクラスのインデックス内のすべてのインポートされたクラスや関数、例えば、Djangoのモデルクラスを、含まれています。インポートを除外し、指定したモジュールで宣言されているクラスと関数のみをリストしたいと思います。
ドキュメントでこれについて何も表示されませんでした。
モジュールを変更せずに、これを行う方法はありますか?
更新:@saimnは__all__
を使用して解決策を提供しましたが、私のプロジェクトでは__all__
を使用していません。モジュールを修正することを伴わない解決策があればいいでしょう。
ありがとうございました。私は ':include-all-objects:'が使われているとき、これがクラスと関数では動作するが、変数ではないことを確認できます(私のコメントでは言及していませんでした)。 – MarkG
フォローアップ:私のモジュールは現在 '__all__'を採用していませんので、モジュールを変更せずにこれを行う方法があればいいと思います。私は ':allowed-package-names:'オプションを試しましたが、記述されているように動作していないようです(Sphinx 1.6.5、Automodapi 0.6) – MarkG
私の最初のコメントは間違っていました。 – MarkG