Date: 2017-03-10
Tags: sphinx

Sphinx本の執筆

Sphinxをはじめよう の改訂作業をやってます。

いくつか章を追加したり、全体的にバージョンを最近の状況に合わせて更新したり、Appendixのリファレンスを書き足したりしてます。自分はリファレンス書き足しを担当してるので、どれを書き足そうかというのを調べるためにリストアップしてみました。

  • reSTの文法: 13

  • reSTのRole: 11

  • reSTのDirective: 29

  • SphinxのRole: 24

  • SphinxのDirective: 15

  • Sphinxの置換、docinfo: 少々

  • Sphinxのドメイン: たくさん

...多すぎました。できるだけ載せたいと思ったけど、絶対使わないのとかもあるので、覚えておくと便利なあたりをピックアップしよう。

ところで、調べてたら知らなかった便利そうな記法に出会ったので紹介します。 クオートリテラルブロック です。

今日覚えた記法

クオートリテラルブロック

こう書きます:

John Doe wrote::

>> Great idea!
>
> Why didn't I think of that?

You just did!  ;-)

こうなります:


John Doe wrote:

>> Great idea!
>
> Why didn't I think of that?

You just did! ;-)


今まで、メール引用やチケット引用をreSTで書くとき面倒くさかったけど、クオートリテラルブロックを使うと良い感じに表示してくれました。こういうのこそ本に載せよう。