.. index:: todo, directive; todo, conf.py; todo

TODOを記録しておきたい
----------------------

conf.pyに

:: 

  extensions = ['sphinx.ext.todo' ]
  
  [extensions]
  todo_include_todos=True
  
としておき、

:: 

  .. todo:: ブロック図を書く

と書くと、TODOがわかりやすく表示されるようになります。

また、

::

  .. todolist:: 

とすると、全部のrstファイル(正確には、TOC Tree)からTODOを探してきて、一
覧表示してくれます。TODOを定義したところに飛べたりしますので便利です。
index.rstなど目立つところに書いておきましょう。

下書き時にはtodolistを使って書くべき項目を分かるようにしておき、リリー
ス時には todo_include_todos=False としてTODOが表示されないようにすると
良いでしょう。