プロジェクトAPI¶

class sphinx.project.Project(srcdir, source_suffix)[ソース]¶

1つの項目はSphinx文書のソースコードセットである.

discover(exclude_paths=[])[ソース]¶: ソースディレクトリのすべての文書ファイルを見つけて入れます docnames それがそうです。

doc2path(docname, basedir=True)[ソース]¶

文書名のファイル名を返します。

もし 基数. Trueであれば，絶対経路として返す.そうでなければ，ソースディレクトリの相対経路として返される.

path2doc(filename)[ソース]¶

文書がDocumentであれば，文書名のdocnameを返す.

ファイル名 ソースディレクトリに対する絶対ディレクトリまたは相対ディレクトリであるべきである.