2017-05-05 11 views
2

を除外する。Pythonのスフィンクスは、私がこのような構造を持つプロジェクトのためにスフィンクスを持つドキュメントを生成していたパターン

私は、ドキュメント/ conf.py

exclude_patterns = ['**/workflow/definitions', 'workflow/definitions', '*workflow/definitions', 'workflow/definitions*', 'workflow/definitions/*', 'workflow/definitions/*.*'] 

にパターンを除外しようとしたが、ワークフロー/定義がまだ自動的に生成されているにもかかわらず。

誰かが正しい除外パターンを表示して、「定義」フォルダを無視する方法を教えてください。

+1

'exclude_patterns'は、(sphinx-buildを実行しているときの)RSTファイルのみを除外するために使用できます。ワークフロー/定義ディレクトリにPythonファイルまたはRSTファイルが含まれていますか? – mzjn

+0

はい自動的に生成される.pyがあります。私はどこに問題があるかを知っていると思います。 私は除外パターンとは、 "このソースコードフォルダは.rtsを生成しません"を意味します。 実際には、 "ドキュメントを生成するときに.rtsを含むこのフォルダを除外します。" 私はそれを受け入れることができるようにあなたのコメントを回答として入れるでしょうか? – jmt

+0

"自動的に生成された.pyについて"あなたが書いたことを理解しているかどうかはわかりませんが、私は答えを投稿しました。 – mzjn

答えて

5

exclude_patternsスフィンクスビルドによる処理からのソースファイル(reStructuredTextのファイル)を除外するために使用することができます。 PythonモジュールからreStructuredTextのファイルを生成するsphinx-apidocを使用した場合

exclude_patternsは効果がありません(ただし、特定のパス名は、世代から除外すべきであることをスフィンクス-apidocを伝えることができます)。

1

exclude_patternsのドキュメントでは、ソースファイルの末尾がすべて.rstであると仮定すると、'workflow/definitions'はそのディレクトリを無視する必要があることを示しています。

あなたができるconfigure the source file suffices as a list

source_suffix = ['.rst', '.txt'] 
関連する問題