Sphinx: sphinx-autobuild で執筆作業の効率を上げる - CUBE SUGAR CONTAINER
先日 SphinxCon JP 2015 で発表の機会に恵まれたんだけど、意外と sphinx-autobuild について知られていなかったようなのでブログにも書いてみることにする。 まず、内容を確認するのに HTML を使っている場合、通常であれば Sphinx の執筆作業は以下の工程の繰り返しになるとおもう。 この繰り返しは本当にめんどうくさいから、執筆への集中を阻害する原因になる。 ドキュメントのソースファイルを編集する Sphinx でビルドする ブラウザにフォーカスを移す ブラウザをリロードする 内容を確認する そこで sphinx-autobuild を使うと (2) から (4) までの作業を自動化してくれる。 これで執筆に集中できるから効率も上がるというもの。 使ってみよう 検証した環境には Mac OS X を使っている。 $ sw_vers ProductName:
Python Livereload を使って Sphinx でドキュメントを書く - Qiita
Sphinx でドキュメントを書いているとソースファイル (reST) を HTML に変換するために make html コマンドを実行することが多いと思います。しばらく書いてみると、ソースファイルを変更する度にコマンドを実行して HTML を確認するためにブラウザをリロードして ... という操作は煩雑に思えてきます。 Python LiveReload を使うとファイルの変更を検知してブラウザを自動的にリロードできるようになります。設定スクリプトは Python で記述しますので、Python に関するドキュメントを書いている場合は頭の切り替えが要らない点がメリットと言えます。 バージョンによって設定方法が違っており、各種 API も変わっています。バージョン 2.2.1 からはそろそろ Python 3.x でも使えるようになってきましたので、導入方法をまとめておきます。 dire
Sphinxの過去と、未来
Sphinxの過去と、未来¶ 著者: Georg Brandl 日付: 2012/12/25 原文: Sphinx, past and future 翻訳: @r_rudi, @shimizukawa このエントリーは日本語の Sphinx Advent Calendar 2012 に参加してくれないかというリクエストに応えて書いています。彼らはすごいよ！彼らは今年Sphinx Conferenceを開催して、イベントには70人もの人たちが集まったんだ！ Sphinx はいまや5歳になってるし、たぶん今までの歴史を振り返り、将来を語るのに良い時期じゃないかな。 このプロジェクトは2007年前半のいつ頃かに始まった。この投稿は私がPythonメーリングリストで見つけた中で一番古い。この時、Pythonのドキュメント作成のためのソースはLaTeXで書かれていた。私は科学的な文章を書くときには絶
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
