sphinx-lua-ls 3.7.0.post1__tar.gz → 3.8.1__tar.gz

{sphinx_lua_ls-3.7.0.post1 → sphinx_lua_ls-3.8.1}/.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 ~/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 ~/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 ~/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:
@@ -79,7 +79,9 @@ jobs:
       # Tests
       - name: Install test dependencies
         if: ${{ matrix.type == 'test' }}
-        run: python -m pip install . --group test
+        run: |
+          python -m pip install . --group test
+          python -m pip install -U sphinx
       - name: Download LuaLs
         if: ${{ matrix.type == 'test' }}
         uses: actions/download-artifact@v4

{sphinx_lua_ls-3.7.0.post1 → sphinx_lua_ls-3.8.1}/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 ## [Unreleased]
 
+## [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 for Sphinx 9.
+
+- Added `lua_ls_skip_versions` config option to selectively avoid certain language server
+  releases.
+
 ## [3.7.0-post1] - 2025-11-14
 
 - Minor documentation tweaks.
@@ -257,6 +268,9 @@ Initial release.
 [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
 [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
 [@bkoropoff]: https://github.com/bkoropoff
 [emmylua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
-[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.7.0-post1...HEAD
+[luals#3301]: https://github.com/LuaLS/lua-language-server/issues/3301
+[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.8.1...HEAD

{sphinx_lua_ls-3.7.0.post1 → sphinx_lua_ls-3.8.1}/CONTRIBUTING.md

@@ -10,8 +10,12 @@
 
    ```shell
    pip install -e . --group dev
+   pip install -U sphinx
    ```
 
+   > *Note:* our tests run with Sphinx 9, but some dependencies are not yet updated
+   > for it; that's why you have to update Sphinx after installing it.
+
 4. Install pre-commit hooks:
 
    ```shell

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.7.0.post1
+Version: 3.8.1
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License-Expression: MIT
@@ -24,7 +24,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: sphinx<9.0,>=8.0
+Requires-Dist: sphinx<10.0,>=8.0
 Requires-Dist: PyGithub<3.0,>=1.59
 Requires-Dist: requests~=2.31
 Dynamic: license-file

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

@@ -52,6 +52,21 @@ Settings
    For LuaLs, default value is ``4.0.0``, for EmmyLua it's ``2.0.0``.
    Use ``None`` to allow any version.
 
+.. py:data:: lua_ls_skip_versions
+   :type: list[str] | None
+
+   List of lua analyzer versions that shouldn't be used.
+
+   For example, if ``lua_ls_skip_versions = ["3.16"]``, language server release
+   ``3.16`` (including all ``3.16.x`` releases) will not be used.
+
+   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]
 
@@ -99,12 +114,12 @@ Settings
    and :rst:dir:`lua:autoobject:class-signature` options.
 
 .. py:data:: lua_ls_class_default_force_non_colon
-   :type:
+   :type: bool
 
    If ``True``, Sphinx-LuaLs will remove ``self`` from class constructor's signature.
 
 .. py:data:: lua_ls_class_default_force_return_self
-   :type:
+   :type: bool
 
    If ``True``, Sphinx-LuaLs will replace class constructor's return type with ``self``.
 

{sphinx_lua_ls-3.7.0.post1 → sphinx_lua_ls-3.8.1}/pyproject.toml

@@ -22,7 +22,7 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "sphinx>=8.0,<9.0",
+    "sphinx>=8.0,<10.0",
     "PyGithub>=1.59,<3.0",
     "requests~=2.31",
 ]
@@ -37,14 +37,14 @@ dev = [
 lint = [
     "black==25.11.0",
     "isort==7.0.0",
-    "pre-commit==4.4.0",
+    "pre-commit==4.5.0",
 ]
 test = [
     "pyright==1.1.407",
     "pytest==9.0.1",
     "sybil==9.2.0",
     "pytest-regressions==2.8.3",
-    "beautifulsoup4==4.14.2",
+    "beautifulsoup4==4.14.3",
     "myst-parser==4.0.1"
 ]
 doc = [

{sphinx_lua_ls-3.7.0.post1 → sphinx_lua_ls-3.8.1}/sphinx_lua_ls/__init__.py

@@ -58,25 +58,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"
-
     cwd = pathlib.Path.cwd()
     try:
         runner = sphinx_lua_ls.lua_ls.resolve(
             backend=domain.config.backend,
-            min_version=min_version,
-            max_version=max_version,
+            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,
@@ -195,6 +183,7 @@ def setup(app: sphinx.application.Sphinx):
     app.add_config_value("lua_ls_auto_install_location", None, rebuild="")
     app.add_config_value("lua_ls_min_version", None, rebuild="env")
     app.add_config_value("lua_ls_max_version", "__auto__", rebuild="env")
+    app.add_config_value("lua_ls_skip_versions", None, rebuild="env")
     app.add_config_value("lua_ls_lua_version", None, rebuild="html")
     app.add_config_value("lua_ls_default_options", None, rebuild="env")
     app.add_config_value("lua_ls_apidoc_roots", None, rebuild="")

{sphinx_lua_ls-3.7.0.post1 → sphinx_lua_ls-3.8.1}/sphinx_lua_ls/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.7.0.post1'
-__version_tuple__ = version_tuple = (3, 7, 0, 'post1')
+__version__ = version = '3.8.1'
+__version_tuple__ = version_tuple = (3, 8, 1)
 
-__commit_id__ = commit_id = 'g7fbbe95bc'
+__commit_id__ = commit_id = 'g03b365db2'

{sphinx_lua_ls-3.7.0.post1 → sphinx_lua_ls-3.8.1}/sphinx_lua_ls/config.py

@@ -14,6 +14,7 @@ import sphinx_lua_ls.domain
 _logger = logging.getLogger("sphinx_lua_ls")
 
 T = _t.TypeVar("T")
+A = _t.ParamSpec("A")
 
 
 @dataclass
@@ -25,6 +26,7 @@ class LuaDomainConfig:
     auto_install_location: pathlib.Path | None = None
     min_version: str | None = None
     max_version: str | None = None
+    skip_versions: list[str] | None = None
     lua_version: str | None = None
     default_options: dict[str, _t.Any] = dataclasses.field(default_factory=dict)
     apidoc_default_options: dict[str, _t.Any] = dataclasses.field(default_factory=dict)
@@ -73,11 +75,17 @@ def _path(name: str, value, root: str | pathlib.Path) -> pathlib.Path:
         raise ConfigError(f"incorrect lua_ls_project_root: {e}") from None
 
 
-def _paths(name: str, value, root: str | pathlib.Path) -> list[pathlib.Path]:
+def _list(
+    name: str,
+    value,
+    checker: _t.Callable[_t.Concatenate[str, object, A], T],
+    *args: A.args,
+    **kwargs: A.kwargs,
+) -> list[T]:
     if value is None:
         value = []
     _type(name, value, list)
-    return [_path(f"{name}[{i}]", v, root) for i, v in enumerate(value)]
+    return [checker(f"{name}[{i}]", v, *args, **kwargs) for i, v in enumerate(value)]
 
 
 def _options(name: str, value) -> dict[str, _t.Any]:
@@ -193,9 +201,10 @@ def set_options(app: sphinx.application.Sphinx):
         )
 
     if config["lua_ls_project_directories"] is not None:
-        domain_config.project_directories = _paths(
+        domain_config.project_directories = _list(
             "lua_ls_project_directories",
             config["lua_ls_project_directories"],
+            _path,
             domain_config.project_root,
         )
 
@@ -221,6 +230,10 @@ def set_options(app: sphinx.application.Sphinx):
             if config["lua_ls_max_version"] != "__auto__"
             else "__auto__"
         )
+    if config["lua_ls_skip_versions"] is not None:
+        domain_config.skip_versions = _list(
+            "lua_ls_skip_versions", config["lua_ls_skip_versions"], _version
+        )
 
     if config["lua_ls_lua_version"]:
         domain_config.lua_version = _str_choices(

{sphinx_lua_ls-3.7.0.post1 → sphinx_lua_ls-3.8.1}/sphinx_lua_ls/domain.py

@@ -1153,7 +1153,7 @@ class LuaDomain(Domain):
 
     name = "lua"
     label = "Lua"
-    object_types: dict[str, ObjType] = {
+    object_types = {
         "function": ObjType(_("function"), "func", "obj", "lua", "_auto"),
         "data": ObjType(_("data"), "data", "obj", "lua", "_auto"),
         "const": ObjType(_("const"), "attr", "const", "obj", "lua", "_auto"),
@@ -1225,7 +1225,7 @@ class LuaDomain(Domain):
         base_lookup_classname: str | None = None
         base_lookup_using: list[str] | None = None
 
-    initial_data: dict[str, dict[str, tuple[Any]]] = {
+    initial_data = {
         "objects": {},  # fullname -> ObjectEntry
         "globals": {},  # modname -> GlobalEntry
         "members": {},  # modname -> MemberEntry

{sphinx_lua_ls-3.7.0.post1 → sphinx_lua_ls-3.8.1}/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,8 +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] | None,
     cache_path: _PathLike | None = None,
     quiet: bool = True,
     env: dict[str, str] | None = None,
@@ -332,6 +337,8 @@ def resolve(
         minimal LuaLs version required.
     :param max_version:
         maximal LuaLs version required. Version is not limited is `None`.
+    :param skip_versions:
+        list of known broken versions.
     :param quiet:
         if true (default), any output from the LuaLs binary is hidden.
     :param env:
@@ -368,12 +375,30 @@ 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(
             backend,
             min_version,
             max_version,
+            skip_versions,
             cache_path,
             _get_path(env),
             install,
@@ -423,9 +448,15 @@ def _get_path(env: dict[str, str] | None) -> str:
 
 
 def _check_version(
-    min_version: str, max_version: str | None, bin_path: _PathLike
+    min_version: str,
+    max_version: str | None,
+    skip_versions: list[str],
+    bin_path: _PathLike,
 ) -> _t.Tuple[bool, _t.Optional[str]]:
     min_version_tuple = tuple(int(c) for c in min_version.split("."))
+    skip_version_tuples = [
+        tuple(int(c) for c in version.split(".")) for version in skip_versions
+    ]
     if max_version:
         max_version_tuple = tuple(int(c) for c in max_version.split("."))
         if max_version_tuple <= min_version_tuple:
@@ -442,15 +473,19 @@ def _check_version(
         if match := re.search(r"(\d+\.\d+\.\d+)", system_version_text):
             system_version = match.group(1)
             system_version_tuple = tuple(int(c) for c in system_version.split("."))
-            if min_version_tuple <= system_version_tuple < max_version_tuple:
+            if (
+                min_version_tuple <= system_version_tuple < max_version_tuple
+                and not _should_skip(system_version_tuple, skip_version_tuples)
+            ):
                 return True, system_version
             else:
                 _logger.debug(
-                    "%s is outdated (got %s, required %s..%s)",
+                    "%s is outdated (got %s, required %s..%s, skip=%r)",
                     bin_path,
                     system_version,
                     min_version,
                     max_version,
+                    skip_versions,
                     type="lua-ls",
                 )
                 return False, system_version
@@ -474,6 +509,7 @@ def _check_and_install(
     backend: _t.Literal["emmylua", "luals"],
     min_version: str,
     max_version: str | None,
+    skip_versions: list[str],
     cache_path: pathlib.Path,
     path: str,
     install: bool,
@@ -485,6 +521,7 @@ def _check_and_install(
         min_version = min_version[1:]
     if max_version and max_version.startswith("v"):
         max_version = max_version[1:]
+    skip_versions = [version.removeprefix("v") for version in skip_versions]
 
     if backend == "emmylua":
         bin_name = "emmylua_doc_cli"
@@ -495,7 +532,7 @@ def _check_and_install(
     system_version = None
     if system_bin_path:
         can_use_system_lua_ls, system_version = _check_version(
-            min_version, max_version, system_bin_path
+            min_version, max_version, skip_versions, system_bin_path
         )
         if can_use_system_lua_ls:
             _logger.debug(
@@ -526,6 +563,7 @@ def _check_and_install(
         return _install_emmylua(
             min_version,
             max_version,
+            skip_versions,
             cache_path,
             path,
             install,
@@ -541,6 +579,7 @@ def _check_and_install(
         return _install_lua_ls(
             min_version,
             max_version,
+            skip_versions,
             cache_path,
             path,
             install,
@@ -554,16 +593,22 @@ def _check_and_install(
         )
 
 
-def _make_version_message(min_version: str, max_version: str | None) -> str:
+def _make_version_message(
+    min_version: str, max_version: str | None, skip_versions: list[str]
+) -> str:
     if max_version:
-        return f"a version between {min_version} and {max_version}"
+        msg = f"a version between {min_version} and {max_version}"
     else:
-        return f"version {min_version} or newer"
+        msg = f"version {min_version} or newer"
+    if skip_versions:
+        msg += ", and not " + ", ".join(skip_versions)
+    return msg
 
 
 def _install_lua_ls(
     min_version: str,
     max_version: str | None,
+    skip_versions: list[str],
     cache_path: pathlib.Path,
     path: str,
     install: bool,
@@ -589,7 +634,7 @@ def _install_lua_ls(
     release_name = release_names.get((platform, machine), None)
     if not install or not release_name:
         if system_bin_path:
-            version = _make_version_message(min_version, max_version)
+            version = _make_version_message(min_version, max_version, skip_versions)
             raise LuaLsError(
                 f"you have lua-language-server {system_version}, "
                 f"but {version} is required; "
@@ -613,7 +658,9 @@ def _install_lua_ls(
         bin_path = cache_path / "bin/lua-language-server"
     if bin_path.exists():
         bin_path.chmod(bin_path.stat().st_mode | stat.S_IEXEC)
-        can_use_cached_binary, _ = _check_version(min_version, max_version, bin_path)
+        can_use_cached_binary, _ = _check_version(
+            min_version, max_version, skip_versions, bin_path
+        )
         if can_use_cached_binary:
             _logger.debug("using cached lua-language-server", type="lua-ls")
             return bin_path, path
@@ -631,6 +678,7 @@ def _install_lua_ls(
             tmp_file = _download_release(
                 min_version,
                 max_version,
+                skip_versions,
                 api,
                 timeout,
                 retry,
@@ -663,15 +711,20 @@ def _install_lua_ls(
 
     if verify:
         can_use_cached_lua_ls, cached_version = _check_version(
-            min_version, max_version, bin_path
+            min_version, max_version, skip_versions, bin_path
         )
         if not can_use_cached_lua_ls:
-            version = _make_version_message(min_version, max_version)
-            raise LuaLsError(
-                f"downloaded lua-language-server printed version {cached_version}, "
-                f"but {version} is required; are you sure lua_ls_min_version "
-                f"and lua_ls_max_version are correct?",
-            )
+            if cached_version is not None:
+                version = _make_version_message(min_version, max_version, skip_versions)
+                raise LuaLsError(
+                    f"downloaded lua-language-server printed version {cached_version}, "
+                    f"but {version} is required; are you sure lua_ls_min_version "
+                    f"and lua_ls_max_version are correct?",
+                )
+            else:
+                raise LuaLsError(
+                    "downloaded lua-language-server failed to print its version"
+                )
     elif not bin_path.exists():
         raise LuaLsError(
             f"downloaded latest lua-language-server is broken: "
@@ -684,6 +737,7 @@ def _install_lua_ls(
 def _install_emmylua(
     min_version: str,
     max_version: str | None,
+    skip_versions: list[str],
     cache_path: pathlib.Path,
     path: str,
     install: bool,
@@ -707,7 +761,7 @@ def _install_emmylua(
     release_name = release_names.get((platform, machine), None)
     if not install or not release_name:
         if system_bin_path:
-            version = _make_version_message(min_version, max_version)
+            version = _make_version_message(min_version, max_version, skip_versions)
             raise LuaLsError(
                 f"you have emmylua_doc_cli {system_version}, but {version} is required; "
                 f"see upgrade instructions "
@@ -730,7 +784,9 @@ def _install_emmylua(
         bin_path = cache_path / "emmylua_doc_cli"
     if bin_path.exists():
         bin_path.chmod(bin_path.stat().st_mode | stat.S_IEXEC)
-        can_use_cached_binary, _ = _check_version(min_version, max_version, bin_path)
+        can_use_cached_binary, _ = _check_version(
+            min_version, max_version, skip_versions, bin_path
+        )
         if can_use_cached_binary:
             _logger.debug("using cached emmylua_doc_cli", type="lua-ls")
             return bin_path, path
@@ -750,6 +806,7 @@ def _install_emmylua(
             tmp_file = _download_release(
                 min_version,
                 max_version,
+                skip_versions,
                 api,
                 timeout,
                 retry,
@@ -782,15 +839,20 @@ def _install_emmylua(
 
     if verify:
         can_use_cached_lua_ls, cached_version = _check_version(
-            min_version, max_version, bin_path
+            min_version, max_version, skip_versions, bin_path
         )
         if not can_use_cached_lua_ls:
-            version = _make_version_message(min_version, max_version)
-            raise LuaLsError(
-                f"downloaded emmylua_doc_cli printed version {cached_version}, "
-                f"but {version} is required; are you sure lua_ls_min_version "
-                f"and lua_ls_max_version are correct?",
-            )
+            if cached_version is not None:
+                version = _make_version_message(min_version, max_version, skip_versions)
+                raise LuaLsError(
+                    f"downloaded emmylua_doc_cli printed version {cached_version}, "
+                    f"but {version} is required; are you sure lua_ls_min_version "
+                    f"and lua_ls_max_version are correct?",
+                )
+            else:
+                raise LuaLsError(
+                    "downloaded emmylua_doc_cli failed to print its version"
+                )
     elif not bin_path.exists():
         raise LuaLsError(
             f"downloaded latest emmylua_doc_cli is broken: " f"can't find {bin_path}",
@@ -802,6 +864,7 @@ def _install_emmylua(
 def _download_release(
     min_version: str,
     max_version: str | None,
+    skip_versions: list[str],
     api: github.Github,
     timeout: int,
     retry: urllib3.Retry,
@@ -814,6 +877,9 @@ def _download_release(
     machine: str,
 ):
     min_version_tuple = tuple(int(c) for c in min_version.split("."))
+    skip_version_tuples = [
+        tuple(int(c) for c in version.split(".")) for version in skip_versions
+    ]
     if max_version:
         max_version_tuple = tuple(int(c) for c in max_version.split("."))
     else:
@@ -832,7 +898,10 @@ def _download_release(
         if match := re.search(r"(\d+\.\d+\.\d+)", release.tag_name):
             release_version = match.group(1)
             release_version_tuple = tuple(int(c) for c in release_version.split("."))
-            if not (min_version_tuple <= release_version_tuple < max_version_tuple):
+            if not (
+                min_version_tuple <= release_version_tuple < max_version_tuple
+                and not _should_skip(release_version_tuple, skip_version_tuples)
+            ):
                 _logger.debug(
                     "release is outside of allowed version range", type="lua-ls"
                 )
@@ -853,7 +922,7 @@ def _download_release(
 
         break
     else:
-        version = _make_version_message(min_version, max_version)
+        version = _make_version_message(min_version, max_version, skip_versions)
         raise LuaLsError(f"unable to find {name} release for {version}")
 
     _logger.debug("downloading %s from %s", name, browser_download_url, type="lua-ls")
@@ -892,6 +961,15 @@ def _download_release(
     return dest / basename
 
 
+def _should_skip(version: tuple[int, ...], skip_versions: list[tuple[int, ...]]):
+    for skip_version in skip_versions:
+        if len(version) < len(skip_version):
+            version += (0,) * (len(skip_version) - len(version))
+        if skip_version == version[: len(skip_version)]:
+            return True
+    return False
+
+
 if __name__ == "__main__":
 
     def main():
@@ -903,6 +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=None)
         parser.add_argument("path", type=pathlib.Path)
 
         _logger.setLevel("DEBUG")
@@ -912,11 +991,18 @@ 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(
                     args.min,
                     args.max,
+                    args.skip,
                     args.path,
                     _get_path(None),
                     True,
@@ -933,6 +1019,7 @@ if __name__ == "__main__":
                 _install_emmylua(
                     args.min,
                     args.max,
+                    args.skip,
                     args.path,
                     _get_path(None),
                     True,

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.7.0.post1
+Version: 3.8.1
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License-Expression: MIT
@@ -24,7 +24,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: sphinx<9.0,>=8.0
+Requires-Dist: sphinx<10.0,>=8.0
 Requires-Dist: PyGithub<3.0,>=1.59
 Requires-Dist: requests~=2.31
 Dynamic: license-file