CUBE SUGAR CONTAINER

技術系のこと書きます。

Sphinx

python-livereload で Re:VIEW の執筆を捗らせてみる

普段、Sphinx でドキュメントを書くときは sphinx-autobuild というツールを使っている。 このツールを使うと、編集している内容をブラウザからリアルタイムで確認できるようになる。 blog.amedama.jp 今回は、上記のような環境が Re:VIEW でも欲しくて pyth…

デジタル出版システム Re:VIEW を使ってみる

書籍の執筆環境として、最近は Re:VIEW の評判が良いので試してみることにした。 しばらく使い込んでみて良さそうだったら、既存の Sphinx の環境から移行するのもありかもしれない。 もちろん Sphinx もドキュメントを書くには良いツールなんだけど、はじめ…

「スマートPythonプログラミング」という本を書きました

表題の通り Python の本を書いたので、そのご紹介です! スマートPythonプログラミング: Pythonのより良い書き方を学ぶ作者: もみじあめ発売日: 2016/03/12メディア: Kindle版この商品を含むブログ (1件) を見る どんな本なの? ひと言で表すと、自信を持っ…

Sphinx: sphinx-autobuild で執筆作業の効率を上げる

先日 SphinxCon JP 2015 で発表の機会に恵まれたんだけど、意外と sphinx-autobuild について知られていなかったようなのでブログにも書いてみることにする。 まず、内容を確認するのに HTML を使っている場合、通常であれば Sphinx の執筆作業は以下の工程…

Python: docstring を書いてみよう

Python の docstring というのは、モジュールやクラス、関数などにつける説明文のこと。 単純なコメントとの違いは、より仕様に近い内容を記述しておくことで API のドキュメントとして利用できる他、別のドキュメントから内容を読み込んで使ったりすること…