sphinx-lua-ls 3.6.0__tar.gz → 3.7.0__tar.gz

sphinx_lua_ls-3.7.0/.cl-keeper.yaml

@@ -0,0 +1,7 @@
+# yaml-language-server: $schema=https://cl-keeper.readthedocs.io/en/latest/schema.json
+version_format: python
+ignore_missing_releases_before: "1.0.0"
+extra_change_categories_map:
+  '(?i)migrating': "migrating"
+extra_change_categories:
+  migrating: ""

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## [Unreleased]
 
+## [3.7.0] - 2025-11-14
+
+- Fixed parsing of `@see` annotations with LuaLs backend.
+
+- Fixed parsing of EmmyLua output after they removed `classDefaultCall` setting.
+
 ## [3.6.0] - 2025-10-17
 
 - Adjusted styles for links in object signatures to match those produced by python domain.
@@ -248,6 +254,7 @@ Initial release.
 [3.5.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.4.0...v3.5.0
 [3.5.0-post1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0...v3.5.0-post1
 [3.6.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0-post1...v3.6.0
+[3.7.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.6.0...v3.7.0
 [@bkoropoff]: https://github.com/bkoropoff
 [emmylua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
-[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.6.0...HEAD
+[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.7.0...HEAD

{sphinx_lua_ls-3.6.0/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.6.0
+Version: 3.7.0
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License-Expression: MIT

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/docs/source/autodoc.rst

@@ -228,7 +228,7 @@ Autodoc directives
    .. rst:directive:option:: class-doc-from: class | ctor | both | separate
 
       Specifies how to generate documentation for classes
-      if :py:data:`class_default_function_name` is configured.
+      if :py:data:`lua_ls_class_default_function_name` is configured.
 
       Options are:
 
@@ -245,7 +245,7 @@ Autodoc directives
    .. rst:directive:option:: class-signature: bases | ctor | both | minimal
 
       Specifies how to generate signatures for classes
-      if :py:data:`class_default_function_name` is configured.
+      if :py:data:`lua_ls_class_default_function_name` is configured.
 
       Options are:
 

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/docs/source/settings.rst

@@ -89,7 +89,7 @@ Settings
       .. lua:autoobject:: foo
          :no-undoc-members:
 
-.. py:data:: class_default_function_name
+.. py:data:: lua_ls_class_default_function_name
    :type: str
 
    Allows specifying which class method represents a class constructor.
@@ -98,22 +98,16 @@ Settings
    :rst:dir:`lua:autoobject:class-doc-from`
    and :rst:dir:`lua:autoobject:class-signature` options.
 
-   If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
-
-.. py:data:: class_default_force_non_colon
+.. py:data:: lua_ls_class_default_force_non_colon
    :type:
 
    If ``True``, Sphinx-LuaLs will remove ``self`` from class constructor's signature.
 
-   If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
-
-.. py:data:: class_default_force_return_self
+.. py:data:: lua_ls_class_default_force_return_self
    :type:
 
    If ``True``, Sphinx-LuaLs will replace class constructor's return type with ``self``.
 
-   If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
-
 .. py:data:: lua_ls_lua_version
    :type: str
 

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/pyproject.toml

@@ -35,13 +35,13 @@ dev = [
     {include-group = "doc"},
 ]
 lint = [
-    "black==25.9.0",
-    "isort==6.1.0",
-    "pre-commit==4.3.0",
+    "black==25.11.0",
+    "isort==7.0.0",
+    "pre-commit==4.4.0",
 ]
 test = [
-    "pyright==1.1.406",
-    "pytest==8.4.2",
+    "pyright==1.1.407",
+    "pytest==9.0.1",
     "sybil==9.2.0",
     "pytest-regressions==2.8.3",
     "beautifulsoup4==4.14.2",
@@ -95,12 +95,3 @@ reportRedeclaration = "none"
 [tool.isort]
 profile = "black"
 skip_gitignore = true
-
-[tool.changelog_keeper]
-ignore_missing_releases_before = "1.0.0"
-
-[tool.changelog_keeper.extra_change_categories_map]
-"(?i)migrating" = "migrating"
-
-[tool.changelog_keeper.extra_change_categories]
-migrating = ""

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.6.0'
-__version_tuple__ = version_tuple = (3, 6, 0)
+__version__ = version = '3.7.0'
+__version_tuple__ = version_tuple = (3, 7, 0)
 
-__commit_id__ = commit_id = 'g0d780b908'
+__commit_id__ = commit_id = 'ge31f54a0d'

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/objtree.py

@@ -153,7 +153,7 @@ class DocstringMixin:
                 else:
                     rejected_see_lines.append(see_line)
             else:
-                if match := re.match(
+                if match := re.search(
                     r"""
                     ^
                     See:[ ]
@@ -169,6 +169,7 @@ class DocstringMixin:
                 ):
                     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}")
@@ -961,8 +962,8 @@ class EmmyLuaParser(Parser):
     def parse(self, json, path: str | pathlib.Path):
         self.path = pathlib.Path(path).expanduser().resolve()
 
-        class_default_config = json["config"]["runtime"]["classDefaultCall"]
-        if class_default_config["functionName"]:
+        class_default_config = json["config"]["runtime"].get("classDefaultCall")
+        if class_default_config and class_default_config.get("functionName"):
             self.class_default_function_name = class_default_config["functionName"]
             self.class_default_force_non_colon = class_default_config["forceNonColon"]
             self.class_default_force_return_self = class_default_config[

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0/sphinx_lua_ls.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.6.0
+Version: 3.7.0
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License-Expression: MIT

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+.cl-keeper.yaml
 .gitignore
 .pre-commit-config.yaml
 .readthedocs.yaml
@@ -70,6 +71,7 @@ test/roots/test-autodoc-emmylua/lua/globals.lua
 test/roots/test-autodoc-emmylua/lua/globals_2.lua
 test/roots/test-autodoc-emmylua/lua/incongruent_export.lua
 test/roots/test-autodoc-emmylua/lua/member_ordering.lua
+test/roots/test-autodoc-emmylua/lua/module_function.lua
 test/roots/test-autodoc-emmylua/lua/module_title.lua
 test/roots/test-autodoc-emmylua/lua/nested_modules.lua
 test/roots/test-autodoc-emmylua/lua/nesting.lua
@@ -85,6 +87,7 @@ test/roots/test-autodoc-emmylua/src/global_tables.rst
 test/roots/test-autodoc-emmylua/src/globals.rst
 test/roots/test-autodoc-emmylua/src/incongruent_export.rst
 test/roots/test-autodoc-emmylua/src/member_ordering.rst
+test/roots/test-autodoc-emmylua/src/module_function.rst
 test/roots/test-autodoc-emmylua/src/module_title.rst
 test/roots/test-autodoc-emmylua/src/nested_modules.rst
 test/roots/test-autodoc-emmylua/src/nesting.rst
@@ -157,6 +160,7 @@ test/test_regression/autodoc-emmylua-globals.html
 test/test_regression/autodoc-emmylua-incongruent_export.html
 test/test_regression/autodoc-emmylua-index.html
 test/test_regression/autodoc-emmylua-member_ordering.html
+test/test_regression/autodoc-emmylua-module_function.html
 test/test_regression/autodoc-emmylua-module_title.html
 test/test_regression/autodoc-emmylua-nested_modules.html
 test/test_regression/autodoc-emmylua-nesting.html

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/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

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/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`.

{sphinx_lua_ls-3.6.0/test/roots/test-autodoc-settings → sphinx_lua_ls-3.7.0/test/roots/test-autodoc-emmylua}/conf.py

@@ -5,3 +5,6 @@ author = "test"
 extensions = ["sphinx_lua_ls"]
 lua_ls_backend = "emmylua"
 lua_ls_project_root = "lua"
+lua_ls_class_default_function_name = "__init"
+lua_ls_class_default_force_non_colon = True
+lua_ls_class_default_force_return_self = True

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/index.rst

@@ -5,11 +5,13 @@ Test autodoc
 
    src/annotations.rst
    src/autoindex.rst
+   src/doctype.rst
    src/globals.rst
    src/global_tables.rst
    src/incongruent_export.rst
    src/member_ordering.rst
    src/module_title.rst
+   src/module_function.rst
    src/nested_modules.rst
    src/nesting_recursive.rst
    src/nesting.rst

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/.emmyrc.json

@@ -34,12 +34,7 @@
     "requireLikeFunction": [],
     "frameworkVersions": [],
     "extensions": [],
-    "requirePattern": [],
-    "classDefaultCall": {
-      "functionName": "__init",
-      "forceNonColon": true,
-      "forceReturnSelf": true
-    }
+    "requirePattern": []
   },
   "workspace": {
     "ignoreDir": [],

sphinx_lua_ls-3.7.0/test/roots/test-autodoc-emmylua/lua/module_function.lua

@@ -0,0 +1,2 @@
+--- Documentation.
+return function() end

sphinx_lua_ls-3.7.0/test/roots/test-autodoc-emmylua/src/module_function.rst

@@ -0,0 +1,6 @@
+Module function
+===============
+
+.. container:: regression
+
+   .. lua:autoobject:: module_function

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/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,6 +284,9 @@
    <br/>
   </dt>
   <dd>
+   <p>
+    Description.
+   </p>
    <p>
     See
     <code class="xref lua lua-obj docutils literal notranslate">
@@ -288,7 +294,7 @@
       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">

sphinx_lua_ls-3.7.0/test/test_regression/autodoc-emmylua-module_function.html

@@ -0,0 +1,20 @@
+<div class="regression docutils container">
+ <p id="lua-module_function">
+  Documentation.
+ </p>
+ <p>
+  <strong>
+   Require:
+  </strong>
+  <code class="docutils literal notranslate">
+   <span class="pre">
+    require_2("module_function"):
+   </span>
+   <span class="xref lua lua-obj n">
+    <span class="pre">
+     fun()
+    </span>
+   </span>
+  </code>
+ </p>
+</div>

{sphinx_lua_ls-3.6.0 → sphinx_lua_ls-3.7.0}/test/test_regression.py

@@ -94,6 +94,7 @@ def test_autodoc_regression(app, src, file_regression):
         "src/globals.html",
         "src/incongruent_export.html",
         "src/member_ordering.html",
+        "src/module_function.html",
         "src/module_title.html",
         "src/nested_modules.html",
         "src/nesting_recursive.html",