docs: treat common sphinx syntax as rst

Summary: Test Plan: Reviewers: Subscribers: Tasks: Tags:
zsol · Jun 1, 2024 · 6671692 · 6671692
1 parent fbfb2a7
commit 6671692
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/py_wtf/indexer/documentation.py b/py_wtf/indexer/documentation.py
@@ -17,6 +17,9 @@
     r"|((^|\n)\.\. )"  # definitions
     r"|([^`]``[^`]+``[^`])"  # inline literal
     r"|((^|\n)>>> )"  # python console snippet
+    r"|(:(param|type|raises) \S+:)"  # Sphinx docstring format
+    r"|(:(return|rtype): \S+)"  # Sphinx docstring format
+    r"|(^\s*:Example:\s*$)"  # Sphinx docstring format
 )
 
 

diff --git a/tests/indexer/test_documentation.py b/tests/indexer/test_documentation.py
@@ -44,6 +44,13 @@ def test_is_rst() -> None:
 1
 """
     )
+    assert is_rst("foo\n:param blah:")
+    assert is_rst("foo\n:param blah: blahblah")
+    assert is_rst("foo\n:type blah: blahblah")
+    assert is_rst("foo\n  :raises blah: blahblah")
+    assert is_rst("   :Example:")
+    assert is_rst("foo\n :return: something")
+    assert is_rst("foo\n :rtype: something")
 
 
 def test_description_content_type_md() -> None: