sphinx-lua-ls 3.8.0__tar.gz → 3.9.0__tar.gz

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/.github/workflows/ci.yaml

@@ -26,17 +26,17 @@ jobs:
       - name: Install dependencies
         run: python -m pip install '.'
       - name: Download LuaLs for Linux
-        run: python sphinx_lua_ls/lua_ls.py linux x86_64 --runtime luals --skip 3.16.0 ~/lua_ls_release/ubuntu-latest
+        run: python -m sphinx_lua_ls.lua_ls linux x86_64 --runtime luals ~/lua_ls_release/ubuntu-latest
       - name: Download LuaLs for Windows
-        run: python sphinx_lua_ls/lua_ls.py win32 amd64 --runtime luals --skip 3.16.0 ~/lua_ls_release/windows-latest
+        run: python -m sphinx_lua_ls.lua_ls win32 amd64 --runtime luals ~/lua_ls_release/windows-latest
       - name: Download LuaLs for MacOs
-        run: python sphinx_lua_ls/lua_ls.py darwin arm --runtime luals --skip 3.16.0 ~/lua_ls_release/macos-latest
+        run: python -m sphinx_lua_ls.lua_ls darwin arm --runtime luals ~/lua_ls_release/macos-latest
       - name: Download EmmyLua for Linux
-        run: python sphinx_lua_ls/lua_ls.py linux x86_64 --runtime emmylua ~/lua_ls_release/ubuntu-latest
+        run: python -m sphinx_lua_ls.lua_ls linux x86_64 --runtime emmylua ~/lua_ls_release/ubuntu-latest
       - name: Download EmmyLua for Windows
-        run: python sphinx_lua_ls/lua_ls.py win32 amd64 --runtime emmylua ~/lua_ls_release/windows-latest
+        run: python -m sphinx_lua_ls.lua_ls win32 amd64 --runtime emmylua ~/lua_ls_release/windows-latest
       - name: Download EmmyLua for MacOs
-        run: python sphinx_lua_ls/lua_ls.py darwin arm --runtime emmylua ~/lua_ls_release/macos-latest
+        run: python -m sphinx_lua_ls.lua_ls darwin arm --runtime emmylua ~/lua_ls_release/macos-latest
       - name: Upload artifact
         uses: actions/upload-artifact@v4
         with:

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/CHANGELOG.md

@@ -2,9 +2,17 @@
 
 ## [Unreleased]
 
+## [3.9.0] - 2026-01-23
+
+- Fixed LaTeX build and improved rendering of multiline signatures in LaTeX ([#46]).
+
+## [3.8.1] - 2025-12-08
+
+- Added LuaLs 3.16.0 to the list of known broken releases ([LuaLS#3301]).
+
 ## [3.8.0] - 2025-12-03
 
-- Added support Sphinx 9.
+- Added support for Sphinx 9.
 
 - Added `lua_ls_skip_versions` config option to selectively avoid certain language server
   releases.
@@ -243,6 +251,7 @@ Initial release.
 
 ## [0.0.1] - 2025-03-09
 
+[#46]:https://github.com/sphinx-contrib/lua-ls/issues/46
 [#18]: https://github.com/sphinx-contrib/lua-ls/pull/18
 [#19]: https://github.com/sphinx-contrib/lua-ls/pull/19
 [#3]: https://github.com/sphinx-contrib/lua-ls/issues/3
@@ -265,6 +274,9 @@ Initial release.
 [3.7.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.6.0...v3.7.0
 [3.7.0-post1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.7.0...v3.7.0-post1
 [3.8.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.7.0-post1...v3.8.0
+[3.8.1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.8.0...v3.8.1
+[3.9.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.8.1...v3.9.0
 [@bkoropoff]: https://github.com/bkoropoff
 [emmylua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
-[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.8.0...HEAD
+[luals#3301]: https://github.com/LuaLS/lua-language-server/issues/3301
+[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.9.0...HEAD

{sphinx_lua_ls-3.8.0/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.9.0}/PKG-INFO

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

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/docs/source/settings.rst

@@ -63,6 +63,10 @@ Settings
    This setting can be used to avoid broken releases without limiting max version
    of the lua analyzer.
 
+   Default is to avoid known broken releases:
+
+   - LuaLs ``3.16.0`` — broken on Linux, fixed in ``3.16.1``.
+
 .. py:data:: lua_ls_default_options
    :type: dict[str, str]
 

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/pyproject.toml

@@ -35,23 +35,23 @@ dev = [
     {include-group = "doc"},
 ]
 lint = [
-    "black==25.11.0",
+    "black==25.12.0",
     "isort==7.0.0",
     "pre-commit==4.5.0",
 ]
 test = [
-    "pyright==1.1.407",
-    "pytest==9.0.1",
-    "sybil==9.2.0",
-    "pytest-regressions==2.8.3",
+    "pyright==1.1.408",
+    "pytest==9.0.2",
+    "sybil==9.3.0",
+    "pytest-regressions==2.9.1",
     "beautifulsoup4==4.14.3",
-    "myst-parser==4.0.1"
+    "myst-parser==5.0.0"
 ]
 doc = [
-    "sybil==9.2.0",
-    "furo==2025.9.25",
-    "sphinx_design==0.6.1",
-    "myst-parser==4.0.1"
+    "sybil==9.3.0",
+    "furo==2025.12.19",
+    "sphinx_design==0.7.0",
+    "myst-parser==5.0.0"
 ]
 
 [project.urls]

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/sphinx_lua_ls/__init__.py

@@ -21,6 +21,7 @@ import sphinx_lua_ls.domain
 import sphinx_lua_ls.inherited
 import sphinx_lua_ls.intersphinx
 import sphinx_lua_ls.lua_ls
+import sphinx_lua_ls.nodes
 import sphinx_lua_ls.objtree
 import sphinx_lua_ls.utils
 from sphinx_lua_ls._version import __version__, __version_tuple__
@@ -58,27 +59,13 @@ def run_lua_ls(app: sphinx.application.Sphinx):
     if not modified:
         return
 
-    min_version = domain.config.min_version
-    if min_version is None:
-        if domain.config.backend == "luals":
-            min_version = "3.0.0"
-        else:
-            min_version = "0.11.0"
-    max_version = domain.config.max_version
-    if max_version == "__auto__":
-        if domain.config.backend == "luals":
-            max_version = "4.0.0"
-        else:
-            max_version = "2.0.0"
-    skip_versions = domain.config.skip_versions
-
     cwd = pathlib.Path.cwd()
     try:
         runner = sphinx_lua_ls.lua_ls.resolve(
             backend=domain.config.backend,
-            min_version=min_version,
-            max_version=max_version,
-            skip_versions=skip_versions or [],
+            min_version=domain.config.min_version,
+            max_version=domain.config.max_version,
+            skip_versions=domain.config.skip_versions,
             cwd=root_dir,
             reporter=sphinx_lua_ls.lua_ls.SphinxProgressReporter(app.verbosity),
             install=domain.config.auto_install,
@@ -273,6 +260,14 @@ def setup(app: sphinx.application.Sphinx):
 
     app.add_css_file("lua.css")
 
+    app.add_node(
+        sphinx_lua_ls.nodes.SigIndentNode,
+        latex=(
+            sphinx_lua_ls.nodes.visit_sig_indent_latex,
+            sphinx_lua_ls.nodes.depart_sig_indent_latex,
+        ),
+    )
+
     return {
         "version": __version__,
         "parallel_read_safe": True,

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.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.8.0'
-__version_tuple__ = version_tuple = (3, 8, 0)
+__version__ = version = '3.9.0'
+__version_tuple__ = version_tuple = (3, 9, 0)
 
-__commit_id__ = commit_id = 'g871de2611'
+__commit_id__ = commit_id = 'gfa7ddc7ee'

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/sphinx_lua_ls/domain.py

@@ -29,6 +29,7 @@ from sphinx.util.docutils import SphinxDirective
 from sphinx.util.nodes import make_id, make_refnode
 
 import sphinx_lua_ls.config
+import sphinx_lua_ls.nodes
 import sphinx_lua_ls.objtree
 from sphinx_lua_ls import utils
 
@@ -49,18 +50,23 @@ class _SigWriter:
     ) -> None:
         self._signode = signode
         self._maximum_signature_line_length = maximum_signature_line_length
-        signode["is_multiline"] = True
-
-        self._line = addnodes.desc_signature_line(add_permalink=True)
-        signode += self._line
+        self._line = self._signode
 
     def br(self):
-        self._line["add_permalink"] = False
-        self._line = addnodes.desc_signature_line(add_permalink=True)
-        self._signode += self._line
+        if self._signode.get("is_multiline"):
+            self._line["add_permalink"] = False
+            self._line = addnodes.desc_signature_line(add_permalink=True)
+            self._signode += self._line
+        else:
+            self._signode["is_multiline"] = True
+            self._line = addnodes.desc_signature_line("", "", *self._signode.children)
+            self._signode.clear()
+            self._signode += self._line
+            self._line = addnodes.desc_signature_line(add_permalink=True)
+            self._signode += self._line
 
-    def ident(self):
-        self._line += addnodes.desc_sig_space("    ", "    ")
+    def indent(self):
+        self._line += sphinx_lua_ls.nodes.SigIndentNode()
 
     def name(self, txt: str):
         self._line += addnodes.desc_sig_name(txt, txt)
@@ -120,7 +126,7 @@ class _SigWriter:
         for i, (arg, typ) in enumerate(params):
             if multiline:
                 self.br()
-                self.ident()
+                self.indent()
 
             if handle_optionals and arg and typ and typ.endswith("?"):
                 arg, typ = arg + "?", typ[:-1]
@@ -165,7 +171,7 @@ class _SigWriter:
         for i, typ in enumerate(params):
             if multiline:
                 self.br()
-                self.ident()
+                self.indent()
 
             if typ:
                 self.typ(typ, inliner)
@@ -486,7 +492,10 @@ class LuaObject(
     ) -> str:
         *prefix_parts, _ = fullname.split(".")
         prefix = ".".join(prefix_parts)
-        return f"{name} ({self.objtype} in {prefix})"
+        if prefix:
+            return f"{name} ({self.objtype} in {prefix})"
+        else:
+            return f"{name} ({self.objtype})"
 
     def add_target_and_index(
         self,

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/sphinx_lua_ls/lua_ls.py

@@ -26,6 +26,10 @@ from sphinx.errors import SphinxError
 from sphinx.util import logging
 from sphinx.util.console import bold, red  # type: ignore
 
+KNOWN_BROKEN_LUA_LS_RELEASES = ["3.16.0"]
+KNOWN_BROKEN_EMMYLUA_RELEASES = []
+
+
 _PathLike: _t.TypeAlias = str | os.PathLike[str]
 
 
@@ -307,9 +311,9 @@ class SphinxProgressReporter(DefaultProgressReporter):
 def resolve(
     *,
     backend: _t.Literal["emmylua", "luals"],
-    min_version: str,
+    min_version: str | None,
     max_version: str | None,
-    skip_versions: list[str],
+    skip_versions: list[str] | None,
     cache_path: _PathLike | None = None,
     quiet: bool = True,
     env: dict[str, str] | None = None,
@@ -371,6 +375,23 @@ def resolve(
     if retry is None:
         retry = urllib3.Retry(10, backoff_factor=0.1)
 
+    print(min_version, max_version, skip_versions)
+    if min_version is None:
+        if backend == "luals":
+            min_version = "3.0.0"
+        else:
+            min_version = "0.11.0"
+    if max_version == "__auto__":
+        if backend == "luals":
+            max_version = "4.0.0"
+        else:
+            max_version = "2.0.0"
+    if skip_versions is None:
+        if backend == "luals":
+            skip_versions = KNOWN_BROKEN_LUA_LS_RELEASES
+        else:
+            skip_versions = KNOWN_BROKEN_EMMYLUA_RELEASES
+
     reporter.start()
     try:
         bin_path, path = _check_and_install(
@@ -960,7 +981,7 @@ if __name__ == "__main__":
         parser.add_argument("machine")
         parser.add_argument("--min", default="0.0.0")
         parser.add_argument("--max", default=None)
-        parser.add_argument("--skip", action="append", default=[])
+        parser.add_argument("--skip", action="append", default=None)
         parser.add_argument("path", type=pathlib.Path)
 
         _logger.setLevel("DEBUG")
@@ -970,6 +991,12 @@ if __name__ == "__main__":
 
         args = parser.parse_args()
 
+        if args.skip is None:
+            if args.runtime == "luals":
+                args.skip = KNOWN_BROKEN_LUA_LS_RELEASES
+            else:
+                args.skip = KNOWN_BROKEN_EMMYLUA_RELEASES
+
         match args.runtime:
             case "luals":
                 _install_lua_ls(

sphinx_lua_ls-3.9.0/sphinx_lua_ls/nodes.py

@@ -0,0 +1,23 @@
+from typing import Any
+
+from docutils import nodes
+from sphinx import addnodes
+
+
+class SigIndentNode(addnodes.desc_sig_space):
+    def __init__(
+        self,
+        rawsource: str = "",
+        text: str = "    ",
+        *children: nodes.Element,
+        **attributes: Any,
+    ):
+        super().__init__(rawsource, text, *children, **attributes)
+
+
+def visit_sig_indent_latex(self, node):
+    self.body.append("~~~~")
+
+
+def depart_sig_indent_latex(self, node):
+    pass

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0/sphinx_lua_ls.egg-info}/PKG-INFO

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

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/sphinx_lua_ls.egg-info/SOURCES.txt

@@ -35,6 +35,7 @@ sphinx_lua_ls/domain.py
 sphinx_lua_ls/inherited.py
 sphinx_lua_ls/intersphinx.py
 sphinx_lua_ls/lua_ls.py
+sphinx_lua_ls/nodes.py
 sphinx_lua_ls/objtree.py
 sphinx_lua_ls/py.typed
 sphinx_lua_ls/pygments.py

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/test/test_regression/autodoc-annotations.html

@@ -33,7 +33,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_private" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -77,7 +76,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_protected" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -121,7 +119,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_package" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -165,7 +162,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_async" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -200,7 +196,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_deprecated" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -235,7 +230,6 @@
    <a class="headerlink" href="#lua-annotations.see_one" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -281,7 +275,6 @@
    <a class="headerlink" href="#lua-annotations.see_one_broken" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -325,7 +318,6 @@
    <a class="headerlink" href="#lua-annotations.see_many" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -389,7 +381,6 @@
    <a class="headerlink" href="#lua-annotations.see_many_broken" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -449,7 +440,6 @@
    <a class="headerlink" href="#lua-annotations.see_no_text" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/test/test_regression/autodoc-emmylua-annotations.html

@@ -33,7 +33,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_private" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -77,7 +76,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_protected" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -121,7 +119,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_package" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -165,7 +162,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_async" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -200,7 +196,6 @@
    <a class="headerlink" href="#lua-annotations.annotation_deprecated" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -235,7 +230,6 @@
    <a class="headerlink" href="#lua-annotations.see_one" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <div class="admonition seealso">
@@ -281,7 +275,6 @@
    <a class="headerlink" href="#lua-annotations.see_one_broken" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <div class="admonition seealso">
@@ -325,7 +318,6 @@
    <a class="headerlink" href="#lua-annotations.see_many" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <div class="admonition seealso">
@@ -379,7 +371,6 @@
    <a class="headerlink" href="#lua-annotations.see_many_broken" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <div class="admonition seealso">

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/test/test_regression/autodoc-emmylua-doctype.html

@@ -38,7 +38,6 @@
    <a class="headerlink" href="#lua-doctype.x" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -100,7 +99,6 @@
    <a class="headerlink" href="#lua-doctype.foo" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -140,7 +138,6 @@
    <a class="headerlink" href="#lua-0" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/test/test_regression/autodoc-emmylua-global_tables.html

@@ -27,7 +27,6 @@
    <a class="headerlink" href="#lua-global_tables.foo" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -83,7 +82,6 @@
      <a class="headerlink" href="#lua-GLOBAL_TABLE.foo" title="Link to this definition">
       ¶
      </a>
-     <br/>
     </dt>
     <dd>
      <p>

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/test/test_regression/autodoc-emmylua-globals.html

@@ -27,7 +27,6 @@
    <a class="headerlink" href="#lua-globals.foo" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -63,7 +62,6 @@
    <a class="headerlink" href="#lua-GlobalsClass" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -102,7 +100,6 @@
    <a class="headerlink" href="#lua-GLOBAL_FOO" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/test/test_regression/autodoc-emmylua-incongruent_export.html

@@ -35,7 +35,6 @@
    <a class="headerlink" href="#lua-incongruent_export_2" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -70,7 +69,6 @@
      <a class="headerlink" href="#lua-incongruent_export_2.foo" title="Link to this definition">
       ¶
      </a>
-     <br/>
     </dt>
     <dd>
      <p>

{sphinx_lua_ls-3.8.0 → sphinx_lua_ls-3.9.0}/test/test_regression/autodoc-emmylua-index.html

@@ -27,7 +27,6 @@
    <a class="headerlink" href="#lua-autodoc.foo" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -62,7 +61,6 @@
    <a class="headerlink" href="#lua-autodoc.baz" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>
@@ -97,7 +95,6 @@
    <a class="headerlink" href="#lua-autodoc.undoc" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <dl class="field-list simple">
@@ -132,7 +129,6 @@
    <a class="headerlink" href="#lua-1" title="Link to this definition">
     ¶
    </a>
-   <br/>
   </dt>
   <dd>
    <p>