Fix #34: parsing of @see annotations with LuaLs

Author: taminomara

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+- Fixed parsing of `@see` annotations with LuaLs backend.
+
 ## [3.6.0] - 2025-10-17
 
 - Adjusted styles for links in object signatures to match those produced by python domain.

sphinx_lua_ls/objtree.py

@@ -153,7 +153,7 @@ def _parse_docstring(self):
                 else:
                     rejected_see_lines.append(see_line)
             else:
-                if match := re.match(
+                if match := re.search(
                     r"""
                     ^
                     See:[ ]
@@ -169,6 +169,7 @@ def _parse_docstring(self):
                 ):
                     typ = match.group("type") or match.group("rejected_type")
                     doc = match.group("doc") or match.group("rejected_doc") or ""
+                    doc = doc.strip()
                     if doc:
                         doc = ": " + doc
                     see_lines.append(f":lua:obj:`{typ}`{doc}")

test/roots/test-autodoc/lua/annotations.lua

@@ -25,20 +25,27 @@ function annotations.annotation_async() end
 --- @deprecated
 function annotations.annotation_deprecated() end
 
+--- Description.
 --- @see annotations text
 --- @deprecated
 function annotations.see_one() end
 
+--- Description.
 --- @see xyz text
 --- @deprecated
 function annotations.see_one_broken() end
 
+--- Description.
 --- @see annotations.annotation_private text 1
 --- @see annotations.annotation_protected text 2
 --- @deprecated
 function annotations.see_many() end
 
+--- Description.
 --- @see xyz text 1
 --- @see abc text 2
 --- @deprecated
 function annotations.see_many_broken() end
+
+--- @see load
+function annotations.see_no_text() end

test/roots/test-autodoc/src/annotations.rst

@@ -23,4 +23,6 @@ Annotations
 
    .. lua:autoobject:: see_many_broken
 
+   .. lua:autoobject:: see_no_text
+
    Ref: :lua:obj:`annotation_deprecated`.

test/test_regression/autodoc-annotations.html

@@ -238,6 +238,9 @@
    <br/>
   </dt>
   <dd>
+   <p>
+    Description.
+   </p>
    <p>
     See
     <a class="reference internal" href="#lua-annotations" title="annotations">
@@ -247,7 +250,7 @@
       </span>
      </code>
     </a>
-    :  text
+    : text
    </p>
    <dl class="field-list simple">
    </dl>
@@ -281,14 +284,17 @@
    <br/>
   </dt>
   <dd>
+   <p>
+    Description.
+   </p>
    <p>
     See
     <code class="xref lua lua-obj docutils literal notranslate">
      <span class="pre">
       xyz
      </span>
     </code>
-    :  text
+    : text
    </p>
    <dl class="field-list simple">
    </dl>
@@ -322,6 +328,9 @@
    <br/>
   </dt>
   <dd>
+   <p>
+    Description.
+   </p>
    <p>
     See:
    </p>
@@ -383,6 +392,9 @@
    <br/>
   </dt>
   <dd>
+   <p>
+    Description.
+   </p>
    <p>
     See:
    </p>
@@ -412,6 +424,48 @@
    </dl>
   </dd>
  </dl>
+ <dl class="lua function">
+  <dt class="sig sig-object lua" id="lua-annotations.see_no_text">
+   <span class="sig-prename descclassname">
+    <span class="pre">
+     annotations.
+    </span>
+   </span>
+   <span class="sig-name descname">
+    <span class="pre">
+     see_no_text
+    </span>
+   </span>
+   <span class="p">
+    <span class="pre">
+     (
+    </span>
+   </span>
+   <span class="p">
+    <span class="pre">
+     )
+    </span>
+   </span>
+   <a class="headerlink" href="#lua-annotations.see_no_text" title="Link to this definition">
+    ¶
+   </a>
+   <br/>
+  </dt>
+  <dd>
+   <p>
+    See
+    <a class="reference external" href="https://www.lua.org/manual/5.4/manual.html#pdf-load">
+     <code class="xref lua lua-obj docutils literal notranslate">
+      <span class="pre">
+       load
+      </span>
+     </code>
+    </a>
+   </p>
+   <dl class="field-list simple">
+   </dl>
+  </dd>
+ </dl>
  <p>
   Ref:
   <a class="reference internal" href="#lua-annotations.annotation_deprecated" title="annotations.annotation_deprecated">