Builder API

課題

もっと拡張すること。

class sphinx.builders.Builder[ソース]

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

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

get_relative_uri(from_, to, typ=None)[ソース]

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

URIを返す方法がない場合には、 environment.NoUri 例外を投げる場合があります。

build_all()[ソース]

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

build_specific(filenames)[ソース]

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() が実行される前に実行したい動作を記述する場所です。

write_doc(docname, doctree)[ソース]

ファイルシステムに実際になにかを書き込む際に使う場所です。

finish()[ソース]

ビルドプロセスの終了です。

デフォルトの実装では何も呼び出されません。