ビルド環境API¶
- class sphinx.environment.BuildEnvironment[ソース]¶
属性
- srcdir¶
ソースディレクトリ。
- doctreedir¶
pickle化された doctree を格納するディレクトリ
- events¶
EventManager
オブジェクト。
- found_docs¶
存在しているdocnameの集合
- metadata¶
docnameをメタデータにマッピングするための辞書です。(参考: ファイルに関するメタデータ).
- titles¶
docnameをdocutilのメインタイトルのノードにマッピングするための辞書です。
- docname¶
現在のドキュメントに対応するdocnameを返します。
ユーティリティ関数
- doc2path(docname: str, base: bool = True) str [ソース]¶
ドキュメント名に関連するファイル名を返します。
baseがTrueの場合には、self.srcdir以下の絶対パスを返します。 baseがFalseの場合には、self.srcdirからの相対パスを返します。
- relfn2path(filename: str, docname: str | None = None) tuple[str, str] [ソース]¶
ドキュメントに対応するファイルパスを、ドキュメントルートからの相対パスと絶対パスで返します。
"filename"が絶対パスであれば、ソースディレクトリからの相対パスとみなされます。*filename*が相対パスであれば、ドキュメントからの相対パスとみなされます。
- note_dependency(filename: str) None [ソース]¶
現在のドキュメントとの依存関係を示すための filename を追加します。
これにより、依存ファイルに変更が生じた際には現在のドキュメントもリビルドされます。
filenameは絶対パスもしくは、ソースディレクトリからの相対パスで指定する必要があります。