From d00fc5016b5328ff4e3038aca64cde712ddb8960 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Thu, 14 Jan 2016 00:53:44 +0100 Subject: [PATCH] DOC add a todo directive to the documentation .. todo:: will create Todos that are listed in the TODO in the documentation --- doc/conf.py | 4 ++++ doc/user/todo.rst | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index dac6859..b110f59 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -34,8 +34,12 @@ extensions = [ 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode', + 'sphinx.ext.todo', ] +# enable todos +todo_include_todos = True + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] diff --git a/doc/user/todo.rst b/doc/user/todo.rst index 2a54df8..8e79fde 100644 --- a/doc/user/todo.rst +++ b/doc/user/todo.rst @@ -35,4 +35,9 @@ Design * use something similar to the `capabilities` in escpos-php +Todos in the codebase +~~~~~~~~~~~~~~~~~~~~~ + +.. todolist:: +