ビルド環境API

class sphinx.environment.BuildEnvironment

属性

app

Sphinx (application) オブジェクトへの参照です

config

Config オブジェクトへの参照です。

project

ターゲットプロジェクト。 Project を参照してください。

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は絶対パスもしくは、ソースディレクトリからの相対パスで指定する必要があります。

new_serialno(category: str = '') → int

インデックスなどで用いるための、シリアルナンバーを返します。

このシリアル番号は、現在の文書のなかで一意であることが保証されます。

note_reread() → None

現在のドキュメントを、次回ビルドの際に自動再読み込みするドキュメント一覧に追加します。