読者です 読者をやめる 読者になる 読者になる

VimでSphinxのプレビュー

Sphinx vim

最近Sphinxでドキュメントを書くことがあったのでQuickRunでプレビューするhookを書いてみました。

NeoBundleでインストールしたらvimrcに次の設定をするとQuickRun時にブラウザでプレビューをしてくれます。
(要open-browser.vim)

let g:quickrun_config['rst'] = {
            \ 'command': 'make',
            \ 'outputter': 'quickfix',
            \ 'hook/sphinx_open/enable' : 1,
            \ 'cmdopt': 'singlehtml',
            \ 'exec': '%c %o'
            \ }

MkdPreviewでもプレビューができるみたいですが、色々とインストールしないといけないようなので試していません。。。

【おまけ】
pdf出力もしたいと思ったのですが、LaTeXやrst2pdfだとイマイチだったのでsinglehtmlで出力したhtmlをwkhtmltopdfでpdf化するhookも書いてみました。

pdf出力する際には以下の設定を使います。

let g:quickrun_config['rst'] = {
            \ 'command': 'make',
            \ 'outputter': 'quickfix',
            \ 'hook/sphinx_open/enable' : 1,
            \ 'hook/sphinx_html2pdf/enable' : 1,
            \ 'cmdopt': 'singlehtml',
            \ 'exec': '%c %o'
            \ }