sphinx-lua-ls 3.5.0.post1__tar.gz → 3.6.0__tar.gz

{sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.6.0}/.github/workflows/ci.yaml

@@ -141,11 +141,6 @@ jobs:
       - name: Build project
         run: |
           python3 -m build .
-      - name: Publish to test pypi
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          repository-url: https://test.pypi.org/legacy/
-          attestations: false
       - name: Publish to pypi
         uses: pypa/gh-action-pypi-publish@release/v1
         with:

{sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.6.0}/CHANGELOG.md

@@ -1,47 +1,53 @@
 # Changelog
 
-## [unreleased]
+## [Unreleased]
 
-## [3.5.0-post1]
+## [3.6.0] - 2025-10-17
+
+- Adjusted styles for links in object signatures to match those produced by python domain.
+
+- Releases are no longer uploaded to test version of PyPi.
+
+## [3.5.0-post1] - 2025-10-03
 
 - Migrated documentation to Read the Docs.
 
 - Moved repository to [sphinx-contrib](https://github.com/sphinx-contrib) organization.
 
-## [3.5.0]
+## [3.5.0] - 2025-10-03
 
 - Added `autodata`, `autoattribute`, `autoclass`, and other `auto*` directives.
 
-  They work like `autoobject`, but apply their doctype to the documented object
-  (if `!doctype` was set in source code, it shouldn't conflict with the used directive).
+  They work like `autoobject`, but apply their doctype to the documented object (if
+  `!doctype` was set in source code, it shouldn't conflict with the used directive).
 
-  They also allow overriding object's signature, which may be useful when
-  automatically generated signature is too long.
+  They also allow overriding object's signature, which may be useful when automatically
+  generated signature is too long.
 
-- Added `lua_ls_max_version` config option to safeguard against incompatible changes
-  to documentation export format.
+- Added `lua_ls_max_version` config option to safeguard against incompatible changes to
+  documentation export format.
 
 - Fixed a few more minor bugs in highlighting of Lua types.
 
-## [3.4.0]
+## [3.4.0] - 2025-09-28
 
-- **Potential breaking change:** use `confdir` instead of `srcdir` as base path
-  for `lua_ls_project_root`.
+- **Potential breaking change:** use `confdir` instead of `srcdir` as base path for
+  `lua_ls_project_root`.
 
   Prior to this change, `lua_ls_project_root` was resolved relative to the directory
   containing source `.rst` files. Documentation, however, was saying that it's resolved
   relative to the directory with `conf.py`.
 
-  This is not an issue, because in most projects `conf.py` and source `.rst` files
-  are located in the same directory. Still, I've decided to be consistent with
-  other Sphinx extensions and use `confdir` instead of `srcdir`.
+  This is not an issue, because in most projects `conf.py` and source `.rst` files are
+  located in the same directory. Still, I've decided to be consistent with other Sphinx
+  extensions and use `confdir` instead of `srcdir`.
 
-  This is a breaking change, but I don't believe there are any projects that
-  use separate `confdir` and `srcdir` (the only reason to do this is if you're
-  hosting multiple documentation sites in the same repo.) For this reason,
-  this change is released as a minor version change.
+  This is a breaking change, but I don't believe there are any projects that use separate
+  `confdir` and `srcdir` (the only reason to do this is if you're hosting multiple
+  documentation sites in the same repo.) For this reason, this change is released as a
+  minor version change.
 
-## [3.3.0]
+## [3.3.0] - 2025-09-28
 
 - Added an option to extend list options (like `:exclude-members:`) without overriding
   defaults:
@@ -53,15 +59,13 @@
 
   Also added `:no-*:` options to ignore defaults.
 
-- Improved display of members which use types instead of names,
-  i.e. `[<type>]` ([#19] by [@bkoropoff]).
+- Improved display of members which use types instead of names, i.e. `[<type>]` ([#19] by
+  [@bkoropoff]).
 
 - Added a warning for situations when `lua_ls_project_directories` contains directories
   outside of the current VCS root.
 
-[#19]: https://github.com/sphinx-contrib/lua-ls/pull/19
-
-## [3.2.0]
+## [3.2.0] - 2025-09-02
 
 - Updated a few dependencies. Most notably, restricted `sphinx` to `<9`.
 
@@ -71,30 +75,26 @@
 
 - Done some internal refactorings.
 
-[#18]: https://github.com/sphinx-contrib/lua-ls/pull/18
-[@bkoropoff]: https://github.com/bkoropoff
-
-## [3.1.0]
+## [3.1.0] - 2025-08-21
 
 - Added pygments lexer for Lua that highlights documentation tags.
 
 - Added option to control maximum signature length before wrapping.
 
-- Sphinx's nitpicky mode will no longer emit warnings
-  for cross-references in signatures.
+- Sphinx's nitpicky mode will no longer emit warnings for cross-references in signatures.
 
 - Fixed generation of URL anchors to avoid duplicates.
 
 - Fixed some edge cases in parsing of type expressions.
 
-## [3.0.0]
+## [3.0.0] - 2025-07-26
 
 - **Breaking change:** changed how `apidoc` generates file names to avoid collisions.
 
 - Supported [EmmyLua] as an alternative backend for documentation export.
 
-  EmmyLua was recently re-implemented in Rust, and its new language server
-  provides some substantial benefits:
+  EmmyLua was recently re-implemented in Rust, and its new language server provides some
+  substantial benefits:
 
   - it has stronger and more flexible type system,
   - it handles aliases and enums way better than LuaLs,
@@ -112,8 +112,8 @@
   .. lua:data:: [integer]: string
   ```
 
-- Added `:globals:` flag for the `lua:autoobject` directive. It will allow
-  automatically documenting global variables defined in a module.
+- Added `:globals:` flag for the `lua:autoobject` directive. It will allow automatically
+  documenting global variables defined in a module.
 
 - The `lua:autoindex` directive now lists globals defined in a module.
 
@@ -131,8 +131,8 @@
   .. lua:class:: Foo<T>
   ```
 
-- Improved linking to Lua language documentation to take into account
-  whether an item is supported for the given Lua version.
+- Improved linking to Lua language documentation to take into account whether an item is
+  supported for the given Lua version.
 
 - Added the `lua:lua` role to compensate for MySt not supporting default roles.
 
@@ -142,34 +142,31 @@
   Reference to a {lua}`logging.Logger.info`.
   ```
 
-- Added the `lua:other-inherited-members` directive and `:inherited-members-table:`
-  flag for the `lua:autoobject` directive.
+- Added the `lua:other-inherited-members` directive and `:inherited-members-table:` flag
+  for the `lua:autoobject` directive.
 
-  These allow listing all members that were inherited by a class but weren't
-  documented within the class body (see [#3]).
+  These allow listing all members that were inherited by a class but weren't documented
+  within the class body (see [#3]).
 
 - Supported markdown output for `apidoc`.
 
 - Added option to separate module members into their own files for `apidoc`.
 
-[EmmyLua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
-[#3]: https://github.com/sphinx-contrib/lua-ls/issues/3
-
 ### Migrating to 3.0.0
 
 - If you're using `apidoc`, you'll need to update links to your documentation.
 
-- You'll need to explicitly specify which language server to use
-  by including `lua_ls_backend` to your `conf.py`.
+- You'll need to explicitly specify which language server to use by including
+  `lua_ls_backend` to your `conf.py`.
 
-## [2.0.1]
+## [2.0.1] - 2025-04-12
 
 - Fixed documentation not being rebuilt after changing lua source code.
 
-## [2.0.0]
+## [2.0.0] - 2025-03-16
 
-- **Breaking change:** don't implicitly convert classes that're derived from `table`
-  to modules. Users should use a `!doctype` comment instead.
+- **Breaking change:** don't implicitly convert classes that're derived from `table` to
+  modules. Users should use a `!doctype` comment instead.
 
 - **Breaking change:** disallow nesting modules inside classes.
 
@@ -194,11 +191,13 @@ $1--- !doctype module
 $1--- @class $2
 ```
 
-Make sure that you only use `!doctype module` on the top-level
-tables that can be imported via `require`. On other objects,
-use `!doctype table` instead, otherwise you'll get errors that modules are not allowed within other objects.
+Make sure that you only use `!doctype module` on the top-level tables that can be imported
+via `require`. On other objects, use `!doctype table` instead, otherwise you'll get errors
+that modules are not allowed within other objects.
+
+## [2.0.0b0] - 2025-03-16
 
-## [1.1.0]
+## [1.1.0] - 2025-03-11
 
 - Added support for `!doc` and `!doctype` comments.
 
@@ -206,30 +205,49 @@ use `!doctype table` instead, otherwise you'll get errors that modules are not a
 
 - Allowed referring `lua:const` objects from `lua:attr` role.
 
-- Fixed a bug when default options would not properly propagate
-  when using `lua:autoobject` with `:recurse:`.
+- Fixed a bug when default options would not properly propagate when using
+  `lua:autoobject` with `:recurse:`.
 
-- Fixed a bug when `lua:autoobject` would deduce incorrect module paths
-  when applied to non-toplevel modules.
+- Fixed a bug when `lua:autoobject` would deduce incorrect module paths when applied to
+  non-toplevel modules.
 
 - Fixed a bug when docstring for a class would be used for undocumented function
   parameters that have this class as their type.
 
 - Fixed types when `lua:autoobject` would infer incorrect types for `data`.
 
-## [1.0.0]
+## [1.0.0] - 2025-03-09
 
 Initial release.
 
-[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0-post1...HEAD
-[3.5.0-post1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0...v3.5.0-post1
-[3.5.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.4.0...v3.5.0
-[3.4.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.3.0...v3.4.0
-[3.3.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.2.0...v3.3.0
-[3.2.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.1.0...v3.2.0
-[3.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.0.0...v3.1.0
-[3.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.1...v3.0.0
-[2.0.1]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.0...v2.0.1
-[2.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.1.0...v2.0.0
+## [0.0.4] - 2025-03-09
+
+## [0.0.3] - 2025-03-09
+
+## [0.0.2] - 2025-03-09
+
+## [0.0.1] - 2025-03-09
+
+[#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
+[0.0.1]: https://github.com/sphinx-contrib/lua-ls/releases/tag/v0.0.1
+[0.0.2]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.1...v0.0.2
+[0.0.3]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.2...v0.0.3
+[0.0.4]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.3...v0.0.4
+[1.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.4...v1.0.0
 [1.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.0.0...v1.1.0
-[1.0.0]: https://github.com/sphinx-contrib/lua-ls/releases/tag/v1.0.0
+[2.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.0b0...v2.0.0
+[2.0.0b0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.1.0...v2.0.0b0
+[2.0.1]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.0...v2.0.1
+[3.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.1...v3.0.0
+[3.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.0.0...v3.1.0
+[3.2.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.1.0...v3.2.0
+[3.3.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.2.0...v3.3.0
+[3.4.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.3.0...v3.4.0
+[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
+[@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

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

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

{sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.6.0}/pyproject.toml

@@ -36,11 +36,11 @@ dev = [
 ]
 lint = [
     "black==25.9.0",
-    "isort==6.0.1",
+    "isort==6.1.0",
     "pre-commit==4.3.0",
 ]
 test = [
-    "pyright==1.1.405",
+    "pyright==1.1.406",
     "pytest==8.4.2",
     "sybil==9.2.0",
     "pytest-regressions==2.8.3",
@@ -95,3 +95,12 @@ 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.5.0.post1 → sphinx_lua_ls-3.6.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.5.0.post1'
-__version_tuple__ = version_tuple = (3, 5, 0, 'post1')
+__version__ = version = '3.6.0'
+__version_tuple__ = version_tuple = (3, 6, 0)
 
-__commit_id__ = commit_id = 'g2fb45db04'
+__commit_id__ = commit_id = 'g0d780b908'

{sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.6.0}/sphinx_lua_ls/autodoc.py

@@ -659,9 +659,9 @@ class AutodocDirectiveMixin(AutodocUtilsMixin):
 
             if self.root.require_type:
                 typ = utils.normalize_type(self.root.require_type)
-                ref_nodes, warn_nodes = sphinx_lua_ls.domain.LuaXRefRole()(
-                    "lua:obj", typ, typ, 0, self.state.inliner
-                )
+                ref_nodes, warn_nodes = sphinx_lua_ls.domain.LuaXRefRole(
+                    innernodeclass=sphinx.addnodes.desc_sig_name
+                )("lua:obj", typ, typ, 0, self.state.inliner)
                 content_node += docutils.nodes.paragraph(
                     "",
                     "",

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

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

{sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.6.0}/test/test_regression/autodoc-emmylua-incongruent_export.html

@@ -8,11 +8,11 @@
     require_2("incongruent_export"):
    </span>
    <a class="reference internal" href="#lua-incongruent_export_2" title="incongruent_export_2">
-    <code class="xref lua lua-obj docutils literal notranslate">
+    <span class="xref lua lua-obj n">
      <span class="pre">
       incongruent_export_2
      </span>
-    </code>
+    </span>
    </a>
   </code>
  </p>