環境APIの構築

class sphinx.environment.BuildEnvironment

Attributes

app

はい。 Sphinx (アプリケーション)オブジェクト。

config

はい。 Config 物体です。

project

目標項目。見 Project それがそうです。

srcdir

ソースディレクトリ。

doctreedir

塩漬け文書木を格納するためのディレクトリ。

events

Vbl.一種 EventManager 物体です。

found_docs

すべての既存文書名の集合.

metadata

文書名を“メタデータ”の辞書にマッピング(参照) 文書範囲のメタデータ ）。

titles

辞書はdocnameをその主タイトルのdocutilsノードにマッピングする.

docname

現在分析中の文書の文書名を返す.

効用方法.

doc2path(docname: str, base: Union[bool, str] = True, suffix: Optional[str] = None) → str

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

もし base Trueであれば，self.srcdirでの絶対パスを返す.もし base Noneであれば，self.srcdirの相対経路を返す.もし base パス文字列であれば，その文字列の下の絶対パスを返す.もし 接尾辞 NONEではなく、config.source_Suffixではなく追加してください。

relfn2path(filename: str, docname: Optional[str] = None) → Tuple[str, str]

文書から参照されるファイルのパス(文書ルートディレクトリと絶対パスに対する)を返す.

入力された“filename”では，絶対ファイル名はソースディレクトリに対するものと考えられ，相対ファイル名は文書を含むディレクトリに対するものである.

note_dependency(filename: str) → None

増列する. ファイル名 現在の文書の依存項とする.

これは，このファイルが変更されれば，文書が再生成されることを意味する.

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

new_serialno(category: str = '') → int

インデックスエントリのターゲットのシーケンス番号のようなシーケンス番号を返す。

この番号が現在の文書で唯一であることを保証する。

note_reread() → None

現在の文書は，次回生成時に自動的に再読み取りされる文書リストに追加される.