ビルド環境 API¶
- class sphinx.environment.BuildEnvironment[ソース]¶
属性
- srcdir¶
ソースディレクトリ。
- doctreedir¶
pickle 化された doctree を格納するためのディレクトリ。
- events¶
EventManagerオブジェクト。
- found_docs¶
既存のすべてのドキュメント名を含む集合。
- metadata¶
ドキュメント名を「メタデータ」にマッピングする辞書 ( ファイル全体のメタデータ を参照)。
- titles¶
ドキュメント名をメインタイトルの docutils ノードにマップする辞書。
- docname¶
現在解析中のドキュメントのドキュメント名を返します。
- parser¶
現在のドキュメントの解析に使用されているパーサーを返します。
ユーティリティメソッド
- doc2path(docname: str, base: bool = True) _StrPath[ソース]¶
ドキュメント名のファイル名を返します。
*base* が True の場合、self.srcdir 下の絶対パスを返します。 *base* が False の場合、self.srcdir への相対パスを返します。
- relfn2path(filename: str, docname: str | None = None) tuple[str, str][ソース]¶
ドキュメントから参照されるファイルへのパスを、ドキュメントルートからの相対パスと絶対パスの両方で返します。
入力 "filename" では、絶対ファイル名はソースディレクトリからの相対パスとして扱われ、相対ファイル名はドキュメントを含むディレクトリからの相対パスとして扱われます。
- note_dependency(filename: str) None[ソース]¶
*filename* を現在のドキュメントの依存関係として追加します。
これは、このファイルが変更された場合、ドキュメントが再構築されることを意味します。
*filename* は絶対パスまたはソースディレクトリからの相対パスである必要があります。