diff --git a/doc/conf.py b/doc/conf.py index 895caba307cb3993adb2d6d36039d57d09f4b55b..2d96d798d663c6990bd0a187c65880cd1e34ec3b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -24,8 +24,12 @@ author = 'Hugo Hörnquist' extensions = [ 'sphinx.ext.autodoc', # Automatically extract source from pypthon files 'sphinx.ext.viewcode', # Adds source viewer to output + 'sphinx.ext.todo', # Add todo-lists to output ] +# Actually enable the todo list +todo_include_todos = True + # Fancy type aliases. # For this to work, each module has to individually run # from __future__ import annotations diff --git a/doc/index.rst b/doc/index.rst index 17dc708b75f3f52c636c9a07a2c354ee3dff6579..017e4af87b2ca1d605d8885b1ccecb4a9a821f3f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -18,3 +18,7 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +TODO +==== +.. todolist:: diff --git a/muppet/lookup.py b/muppet/lookup.py index d51b1af6987cb52e61b82008a579b16046b6e5c2..17511f73297ed55f4dfbb7a31d36895ea408ac59 100644 --- a/muppet/lookup.py +++ b/muppet/lookup.py @@ -18,9 +18,8 @@ Example .ref('text') \ .exec() -TODO ----- -- ``select`` +.. todo:: + ``select`` Selects all values from a list which matches a given expression. This would however require us to manage multiple values at once. """