Web フック

Web フックはとても素晴しい仕組みで、Web という環境を、引っ張ってくる(プルする)ものではなく、通知する(プッシュする)ものに変えてくれます。 RTD ではプロジェクトにコミットした際の通知先となる URL を用意しており、この URL への通知によって、ドキュメントの取得とリビルドを行ないます。 ドキュメントに何か変更があった場合のみリビルドするため、サーバサイドにとっては負荷の低い仕組みになっています。

プッシュ通知を利用している人ならご存知の通り、リポジトリへプッシュすると、すぐにドキュメントが更新される様は驚くばかりです。 もし github を利用しているのなら、自分のプロジェクトのポストコミットフックとして http://readthedocs.org/github を指定するだけです。 github 以外の場合は、プロジェクト詳細ページに http://readthedocs.org/build/<pk> のような、 プロジェクト専用の post-commit フック URL が掲載されているので、そちらを利用することができます。

Project Versions

Previous topic

助けを得るには

Next topic

API

This Page