新しいビルダーを作成する

Todo

Expand this.

class sphinx.builders.Builder

このクラスはすべてのビルダーのベースクラスです。

これらのメソッドは事前に定義されており、アプリケーションから呼び出されます。

load_env()

ビルダー環境をセットアップします。

get_relative_uri(from_, to, typ=None)

2つのソースファイル間の相対URIを返します。URIを返す方法がない場合には、 environment.NoUri 例外を投げる場合があります。

build_all()

すべてのソースファイルをビルドします。

build_specific(filenames)

オプションで指定されたファイル名のリストに含まれる、変更が必要なものだけ再ビルドします。

build_update()

最後のビルドの後に変更されたり、追加されたものだけ再ビルドします。

build(docnames, summary=None, method='update')

メインのビルド用メソッドです。最初に環境をアップデートしてから, write() を呼びます。

これらのメソッドは派生されたビルダークラス側でオーバーライドすることができます:

init()

必要なテンプレートをロードしたり、初期化を行うためのメソッドです。 デフォルトの実装では、何も行いません。

get_outdated_docs()

ビルドが必要な、古いファイルを返すイテレータを返します。言い換えると、アップデートビルドを行うと、何がビルドされるか、というのを説明する文字列を返します。

もしもビルダーがソースファイルに関連する、個別のファイルを出力しない場合には、ここでは文字列を返してください。その場合には、書かれるべきファイルのイテレータを返します。

get_target_uri(docname, typ=None)

ドキュメント名に関連する、対象のURLを返します。

typはそれぞれのビルダーごとのリンクの修飾子として使うことができます。

prepare_writing(docnames)

write_doc(docname, doctree)

finish()

ビルドプロセスの終了です。デフォルトの実装では何も呼び出されません。