構築器API

課題

これを拡大してください。

class sphinx.builders.Builder

これは全ての構築器の基本クラスです

構築器クラスには、以下の属性を設定する必要があります。

name = ''

ビルダの名前は、-bコマンド·ライン·オプションに使用されます。

format = ''

生成器の出力フォーマットは，文書出力が生成されていなければ“”となる.

epilog = ''

The message emitted upon successful build completion. This can be a printf-style template string with the following keys: outdir, project

supported_image_types = []

生成器によってサポートされる画像フォーマットのMIMEタイプリスト。画像ファイルはここに表示された順に検索される.

supported_remote_images = False

ビルダがリモート·イメージをサポートしているかどうか。

supported_data_uri_images = False

ビルダはデータURIをサポートしているかどうか.

default_translator_class = None

生成器のデフォルト変換器クラス。これは以下のようにカバーできる app.set_translator() それがそうです。

これらの方法は、予め定義されており、アプリケーションから呼び出される。

get_relative_uri(from_: str, to: str, typ: Optional[str] = None) → str

2つのソースファイル名間の相対URIを返す。

合理的なURIを返すことができなければ，環境.NoUriを誘発する可能性がある.

build_all() → None

すべてのソースファイルを構築します。

build_specific(filenames: List[str]) → None

中の変更は再生成に必要な数のみです。 ファイル名 それがそうです。

build_update() → None

前回生成されてから変更または追加されたコンテンツのみを再構成します。

build(docnames: Iterable[str], summary: Optional[str] = None, method: str = 'update') → None

主な構築方法。

まず環境を更新してから呼び出します write() それがそうです。

コンクリート生成器類でこれらの方法を覆うことができます

init() → None

必要なテンプレートをロードし、初期化を実行します。デフォルト実装では、何の操作も実行されません。

get_outdated_docs() → Union[str, Iterable[str]]

期限切れ出力ファイルの反復可能な数を返すか、または更新バージョンで生成されるコンテンツを記述する文字列を返す。

ビルダがソースファイルに対応する単一のファイルを出力していない場合、ここで文字列を返してください。そうである場合、書き込みが必要なファイルの反復可能性を返す。

get_target_uri(docname: str, typ: Optional[str] = None) → str

文書名のターゲットURIを返す.

typ 単一のビルダのリンク特徴を定義するために使用することができる。

prepare_writing(docnames: Set[str]) → None

その前に、その中に論理を追加することができます write_doc() 運行

write_doc(docname: str, doctree: docutils.nodes.document) → None

その中に実際にファイルシステムにいくつかの内容を書き込むことができます。

finish() → None

構築過程を完成させる。

デフォルト実装では、何の操作も実行されません。

Attributes

events

Vbl.一種 EventManager 物体です。