私は次のような構造のプロジェクト用にSphinxを使用してドキュメントを生成しています:
+ project
|
+- docs
|
+- tests
|
+- workflow -+- definitions -+- <some folders>
|
+- <rest of the project>
テストとワークフロー/定義をドキュメントから除外したい。
Docs /conf.pyでパターンを除外してみました
exclude_patterns = ['**/workflow/definitions', 'workflow/definitions', '*workflow/definitions', 'workflow/definitions*', 'workflow/definitions/*', 'workflow/definitions/*.*']
ただし、ワークフロー/定義は自動的に生成されます。
誰かが「definitions」フォルダを無視する正しい除外パターンを教えてもらえますか?
exclude_patterns
sphinx-buildによる処理からソースファイル(reStructuredTextファイル)を除外するために使用できます。
exclude_patterns
sphinx-apidoc を使用してPythonモジュール(ただし、特定のパス名を生成から除外する必要があることをsphinx-apidocに伝えることができます)。
exclude_patterns のドキュメントは、ソースファイルがすべて'workflow/definitions'
で終わると仮定して、.rst
がそのディレクトリを無視する必要があることを示しています。
次のことができます ソースファイルをリストとして設定するだけで十分です :
source_suffix = ['.rst', '.txt']