ビルド環境API

class sphinx.environment.BuildEnvironment[ソース]

属性

app

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

config

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

srcdir

ソースディレクトリ。

confdir

Directory containing conf.py.

doctreedir

pickle化された doctree を格納するディレクトリ

found_docs

存在しているdocnameの集合

metadata

docnameをメタデータにマッピングするための辞書です。(参考: ファイルに関するメタデータ).

titles

docnameをdocutilのメインタイトルのノードにマッピングするための辞書です。

docname

現在のドキュメントに対応するdocnameを返します。

ユーティリティ関数

warn(docname, msg, lineno=None, **kwargs)[ソース]

警告を発生させます。

app.warn() を使用するのとは異なり、警告は即時には発行されず、すべての環境アップデートが済んでからすべての警告を発行するため、まとめられます。

warn_node(msg, node, **kwargs)[ソース]

warn()と似ていますが、nodeが持っているソース情報とともに警告を発生させます。

doc2path(docname, base=True, suffix=None)[ソース]

ドキュメント名に関連するファイル名を返します。

baseがTrueの場合には、self.srcdir以下の絶対パスを返します。 baseがNoneの場合には、self.srcdirからの相対パスを返します。 baseがパスを表す文字列であれば、そこ以下の絶対パスを返します。 suffix がNoneでない場合には、それがconfig.source_suffixの代わりにサフィックスとして追加されます。

relfn2path(filename, docname=None)[ソース]

ドキュメントに対応するファイルパスを、ドキュメントルートからの相対パスと絶対パスで返します。

“filename”が絶対パスであれば、ソースディレクトリからの相対パスとみなされます。*filename*が相対パスであれば、ドキュメントからの相対パスとみなされます。

note_dependency(filename)[ソース]

現在のドキュメントとの依存関係を示すための filename を追加します。

これにより、依存ファイルに変更が生じた際には現在のドキュメントもリビルドされます。

filenameは絶対パスもしくは、ソースディレクトリからの相対パスで指定する必要があります。

new_serialno(category='')[ソース]

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

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

note_reread()[ソース]

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