Edited at

Sphinx ドキュメントをGulpでwatchして自動更新するよ〜

More than 3 years have passed since last update.

Sphinxいじり始めて、なんだか凄ーく面倒くさいことに遭遇・・・

Sphinxはドキュメント生成してくれて凄いんだけど、

修正>Make>ブラウザで確認 って面倒くさくね???

ってことで、修正中はGulpで監視して、変更掛かったらMakeさせるという、僕のMacには酷で可哀想な感じですが仕事して貰おうと思います。


セットアップ

とりあえず、NodeJSとGulpJSは使えるようにしておいて下さい。※ ここでは割愛します。

その後、ドキュメントがあるカレントディレクトリに移動します。

$ npm init # いろいろ聞かれますが、全部enterでOKですよ。

$ npm install gulp gulp-util --save-dev
$ npm install --save-dev gulp-shell


Gulpタスク

gulpfile.jsは次の通り。

var gulp  = require('gulp')

var shell = require('gulp-shell')

gulp.task('make', shell.task([
'make html'
]))

gulp.task('default', function(){
gulp.watch('./**/*.rst', ['make']);
});


実行

$ gulp

あとは、ひたすらドキュメントを書くべし・・・

以上、簡単ですが、ご参考まで。

此方も合わせてどうぞ。

Mac OS X でShpinx(Python製ドキュメンテーションビルダー) - Qiita