プロジェクトのドキュメントを作成するために sphinx を使用しようとしています。これは、プロジェクト内のモジュールに分割された一連の関数です。
ドキュメントで公開する関数の小さなサブセットのみが必要なので、ドキュメントautodoc-skip-member文字列にタグを付けて不要なものを除外していましたが、不要な関数をリストしないことで機能しているように見えますが、空のモジュールの束になってしまいますおよびサブモジュール。
空のモジュールをリストしないようにスフィンクスに指示する方法はありますか? この機能を使用できると思いますexcludeが、新しいコードを追加するプロセスが自動化されないため、常に除外リストを維持する必要があります。
このフローを使用して HTML ドキュメントを生成しています。
sphinx-apidoc -f -e -M -o source/ ../src/
sphinx-build source/ build/
これは、最終的な HTML ドキュメントにリストされているモジュールでconf.py返される場合でも、ファイル内の関数を除外するコードです。True
def include_only(app, what, name, obj, skip, options):
if obj.__doc__ is not None and "::public" in obj.__doc__:
return False
return True
def setup(app):
app.connect('autodoc-skip-member', include_only)