From 1ffff49872433ef83ec23b802109e8dfd671ffdd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Hugo=20H=C3=B6rnquist?= <hugo@lysator.liu.se>
Date: Sun, 4 Jun 2023 01:29:15 +0200
Subject: [PATCH] Start using sphinx's TODO module.
---
doc/conf.py | 4 ++++
doc/index.rst | 4 ++++
muppet/lookup.py | 5 ++---
3 files changed, 10 insertions(+), 3 deletions(-)
diff --git a/doc/conf.py b/doc/conf.py
index 895caba..2d96d79 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 17dc708..017e4af 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 d51b1af..17511f7 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.
"""
--
GitLab