Sphinx には Sphinx 拡張(Sphinx extension)と呼ばれるプラグイン機能があります。 Sphinx 拡張を使うとドキュメントを書くのがより便利になったり、 ドキュメントの表現がより豊富になったりします。 今日はその Sphinx 拡張の中から僕がよく使うもの、便利そうで使ってみたいものを それぞれいくつかピックアップしてご紹介します。 sphinx.ext.todo Sphinx に同梱されている拡張モジュールで、ドキュメントに ToDo を書き残すことができます。 有効にするには conf.py に以下の記述を追加します。 # sphinx.ext.todo モジュールを読み込む extensions += ['sphinx.ext.todo'] # ToDo 項目を表示する (デフォルトは表示しない; False) todo_include_todos = T
![(6日目) Sphinx 拡張の紹介 - Hack like a rolling stone](https://cdn-ak-scissors.b.st-hatena.com/image/square/7ed9d599c0c5b9a180af8e863d42fb827642a573/height=288;version=1;width=512/http%3A%2F%2Fcdn-ak.f.st-hatena.com%2Fimages%2Ffotolife%2Ft%2Ftk0miya%2F20111206%2F20111206184922.png)