summaryrefslogtreecommitdiffstats
path: root/tests/test_sphinx/sourcedirs/fieldlist
diff options
context:
space:
mode:
Diffstat (limited to 'tests/test_sphinx/sourcedirs/fieldlist')
-rw-r--r--tests/test_sphinx/sourcedirs/fieldlist/conf.py4
-rw-r--r--tests/test_sphinx/sourcedirs/fieldlist/index.md19
2 files changed, 23 insertions, 0 deletions
diff --git a/tests/test_sphinx/sourcedirs/fieldlist/conf.py b/tests/test_sphinx/sourcedirs/fieldlist/conf.py
new file mode 100644
index 0000000..1e3d992
--- /dev/null
+++ b/tests/test_sphinx/sourcedirs/fieldlist/conf.py
@@ -0,0 +1,4 @@
+extensions = ["myst_parser"]
+exclude_patterns = ["_build"]
+
+myst_enable_extensions = ["fieldlist"]
diff --git a/tests/test_sphinx/sourcedirs/fieldlist/index.md b/tests/test_sphinx/sourcedirs/fieldlist/index.md
new file mode 100644
index 0000000..2ed4856
--- /dev/null
+++ b/tests/test_sphinx/sourcedirs/fieldlist/index.md
@@ -0,0 +1,19 @@
+:orphan:
+
+# Test
+
+:field:
+
+:*field*: content
+
+```{py:function} send_message(sender, priority)
+
+Send a message to a recipient
+
+:param str sender: The person sending the message
+:param priority: The priority of the message, can be a number 1-5
+:type priority: int
+:return: the message id
+:rtype: int
+:raises ValueError: if the message_body exceeds 160 characters
+```