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が表示されないようにすると良いでしょう。

前のトピックへ

参考文献を書きたい

次のトピックへ

refer (Internal Hyperlink) したい

このページ