From fb9374980beb66aaca966b491f2cdef397eea606 Mon Sep 17 00:00:00 2001 From: woutdenolf Date: Fri, 17 Jun 2022 13:18:55 +0200 Subject: [PATCH 1/3] add sphinx todo extension --- manual/source/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/manual/source/conf.py b/manual/source/conf.py index 0160d58f2..dd6110126 100644 --- a/manual/source/conf.py +++ b/manual/source/conf.py @@ -46,6 +46,7 @@ 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', 'sphinx.ext.githubpages', + 'sphinx.ext.todo' ] # Add any paths that contain templates here, relative to this directory. From c79dc6666e6bf68f2733b8a36bdbce0b97a7ad3f Mon Sep 17 00:00:00 2001 From: woutdenolf Date: Fri, 17 Jun 2022 13:21:57 +0200 Subject: [PATCH 2/3] fix content block warning --- base_classes/NXbending_magnet.nxdl.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/base_classes/NXbending_magnet.nxdl.xml b/base_classes/NXbending_magnet.nxdl.xml index 08903497b..9ca66fe29 100644 --- a/base_classes/NXbending_magnet.nxdl.xml +++ b/base_classes/NXbending_magnet.nxdl.xml @@ -104,7 +104,7 @@ NXtransformations group. But NeXus allows them to be stored anywhere. .. todo:: - Add a definition for the reference point of a bending magnet. + Add a definition for the reference point of a bending magnet. From 260e85b349151d08b076110ec29613e58c3a0fd7 Mon Sep 17 00:00:00 2001 From: woutdenolf Date: Fri, 17 Jun 2022 17:44:06 +0200 Subject: [PATCH 3/3] add todo show option (commented) --- manual/source/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/manual/source/conf.py b/manual/source/conf.py index dd6110126..b5e94428a 100644 --- a/manual/source/conf.py +++ b/manual/source/conf.py @@ -49,6 +49,9 @@ 'sphinx.ext.todo' ] +# Show `.. todo` directives in the output +# todo_include_todos = True + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']