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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (193) hide show
  1. sphinx_lua_ls-3.7.0/.cl-keeper.yaml +7 -0
  2. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/.github/workflows/ci.yaml +0 -5
  3. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/CHANGELOG.md +96 -71
  4. {sphinx_lua_ls-3.5.0.post1/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.7.0}/PKG-INFO +1 -1
  5. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/autodoc.rst +2 -2
  6. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/settings.rst +3 -9
  7. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/pyproject.toml +5 -5
  8. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/_version.py +3 -3
  9. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/autodoc.py +3 -3
  10. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/objtree.py +4 -3
  11. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0/sphinx_lua_ls.egg-info}/PKG-INFO +1 -1
  12. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls.egg-info/SOURCES.txt +4 -0
  13. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/lua/annotations.lua +7 -0
  14. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/annotations.rst +2 -0
  15. {sphinx_lua_ls-3.5.0.post1/test/roots/test-autodoc-settings → sphinx_lua_ls-3.7.0/test/roots/test-autodoc-emmylua}/conf.py +3 -0
  16. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/index.rst +2 -0
  17. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/.emmyrc.json +1 -6
  18. sphinx_lua_ls-3.7.0/test/roots/test-autodoc-emmylua/lua/module_function.lua +2 -0
  19. sphinx_lua_ls-3.7.0/test/roots/test-autodoc-emmylua/src/module_function.rst +6 -0
  20. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-annotations.html +56 -2
  21. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-incongruent_export.html +2 -2
  22. sphinx_lua_ls-3.7.0/test/test_regression/autodoc-emmylua-module_function.html +20 -0
  23. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression.py +1 -0
  24. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/.github/dependabot.yml +0 -0
  25. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/.gitignore +0 -0
  26. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/.pre-commit-config.yaml +0 -0
  27. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/.readthedocs.yaml +0 -0
  28. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/CONTRIBUTING.md +0 -0
  29. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/LICENSE +0 -0
  30. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/README.md +0 -0
  31. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/conftest.py +0 -0
  32. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/Makefile +0 -0
  33. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/make.bat +0 -0
  34. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/_extra/robots.txt +0 -0
  35. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/apidoc.rst +0 -0
  36. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/conf.py +0 -0
  37. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/directives.rst +0 -0
  38. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/example/.emmyrc.json +0 -0
  39. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/example/logging.lua +0 -0
  40. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/example.rst +0 -0
  41. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/index.rst +0 -0
  42. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/installation.rst +0 -0
  43. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/quickstart.rst +0 -0
  44. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/docs/source/roles.rst +0 -0
  45. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/setup.cfg +0 -0
  46. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/__init__.py +0 -0
  47. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/apidoc.py +0 -0
  48. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/autoindex.py +0 -0
  49. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/config.py +0 -0
  50. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/domain.py +0 -0
  51. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/inherited.py +0 -0
  52. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/intersphinx.py +0 -0
  53. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/lua_ls.py +0 -0
  54. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/py.typed +0 -0
  55. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/pygments.py +0 -0
  56. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/static/lua.css +0 -0
  57. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls/utils.py +0 -0
  58. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls.egg-info/dependency_links.txt +0 -0
  59. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls.egg-info/requires.txt +0 -0
  60. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/sphinx_lua_ls.egg-info/top_level.txt +0 -0
  61. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/conftest.py +0 -0
  62. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-apidoc/.gitignore +0 -0
  63. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-apidoc/Makefile +0 -0
  64. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-apidoc/conf.py +0 -0
  65. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-apidoc/index.rst +0 -0
  66. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-apidoc/lua/mod/inner.lua +0 -0
  67. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-apidoc/lua/mod.lua +0 -0
  68. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-apidoc/make.bat +0 -0
  69. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/Makefile +0 -0
  70. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/conf.py +0 -0
  71. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/index.rst +0 -0
  72. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/lua/globals.lua +0 -0
  73. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/lua/globals_2.lua +0 -0
  74. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/lua/member_ordering.lua +0 -0
  75. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/lua/module_title.lua +0 -0
  76. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/lua/nested_modules.lua +0 -0
  77. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/lua/nesting.lua +0 -0
  78. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/lua/object_types.lua +0 -0
  79. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/lua/relative_resolve.lua +0 -0
  80. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/make.bat +0 -0
  81. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/autoindex.rst +0 -0
  82. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/globals.rst +0 -0
  83. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/member_ordering.rst +0 -0
  84. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/module_title.rst +0 -0
  85. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/nested_modules.rst +0 -0
  86. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/nesting.rst +0 -0
  87. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/nesting_recursive.rst +0 -0
  88. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/object_types.rst +0 -0
  89. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc/src/relative_resolve.rst +0 -0
  90. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/Makefile +0 -0
  91. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/annotations.lua +0 -0
  92. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/doctype.lua +0 -0
  93. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/foo/x.lua +0 -0
  94. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/global_tables.lua +0 -0
  95. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/globals.lua +0 -0
  96. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/globals_2.lua +0 -0
  97. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/incongruent_export.lua +0 -0
  98. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/member_ordering.lua +0 -0
  99. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/module_title.lua +0 -0
  100. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/nested_modules.lua +0 -0
  101. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/nesting.lua +0 -0
  102. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/object_types.lua +0 -0
  103. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/relative_resolve.lua +0 -0
  104. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/signatures.lua +0 -0
  105. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/lua/using.lua +0 -0
  106. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/make.bat +0 -0
  107. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/annotations.rst +0 -0
  108. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/autoindex.rst +0 -0
  109. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/doctype.rst +0 -0
  110. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/global_tables.rst +0 -0
  111. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/globals.rst +0 -0
  112. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/incongruent_export.rst +0 -0
  113. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/member_ordering.rst +0 -0
  114. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/module_title.rst +0 -0
  115. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/nested_modules.rst +0 -0
  116. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/nesting.rst +0 -0
  117. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/nesting_recursive.rst +0 -0
  118. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/object_types.rst +0 -0
  119. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/relative_resolve.rst +0 -0
  120. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/require.rst +0 -0
  121. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/signatures.rst +0 -0
  122. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-emmylua/src/using.rst +0 -0
  123. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-roots/Makefile +0 -0
  124. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-roots/conf.py +0 -0
  125. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-roots/index.rst +0 -0
  126. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-roots/lua/root_1/autodoc.lua +0 -0
  127. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-roots/lua/root_2/autodoc.lua +0 -0
  128. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-roots/make.bat +0 -0
  129. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-settings/Makefile +0 -0
  130. {sphinx_lua_ls-3.5.0.post1/test/roots/test-autodoc-emmylua → sphinx_lua_ls-3.7.0/test/roots/test-autodoc-settings}/conf.py +0 -0
  131. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-settings/index.rst +0 -0
  132. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-settings/lua/autodoc.lua +0 -0
  133. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-settings/make.bat +0 -0
  134. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-settings-override/Makefile +0 -0
  135. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-settings-override/conf.py +0 -0
  136. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-settings-override/index.rst +0 -0
  137. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-settings-override/lua/autodoc.lua +0 -0
  138. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-autodoc-settings-override/make.bat +0 -0
  139. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/Makefile +0 -0
  140. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/conf.py +0 -0
  141. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/index.rst +0 -0
  142. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/make.bat +0 -0
  143. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/src/annotations.rst +0 -0
  144. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/src/autoindex.rst +0 -0
  145. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/src/directives.rst +0 -0
  146. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/src/inherited.rst +0 -0
  147. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/src/modules.rst +0 -0
  148. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-doc/src/refs.rst +0 -0
  149. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-intersphinx/Makefile +0 -0
  150. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-intersphinx/conf.py +0 -0
  151. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-intersphinx/index.rst +0 -0
  152. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/roots/test-intersphinx/make.bat +0 -0
  153. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_parse.py +0 -0
  154. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/apidoc-md-sep.yml +0 -0
  155. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/apidoc-md.yml +0 -0
  156. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/apidoc-rst-sep.yml +0 -0
  157. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/apidoc-rst.yml +0 -0
  158. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-autoindex.html +0 -0
  159. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-annotations.html +0 -0
  160. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-autoindex.html +0 -0
  161. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-doctype.html +0 -0
  162. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-global_tables.html +0 -0
  163. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-globals.html +0 -0
  164. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-index.html +0 -0
  165. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-member_ordering.html +0 -0
  166. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-module_title.html +0 -0
  167. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-nested_modules.html +0 -0
  168. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-nesting.html +0 -0
  169. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-nesting_recursive.html +0 -0
  170. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-object_types.html +0 -0
  171. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-relative_resolve.html +0 -0
  172. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-require.html +0 -0
  173. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-signatures.html +0 -0
  174. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-emmylua-using.html +0 -0
  175. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-globals.html +0 -0
  176. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-member_ordering.html +0 -0
  177. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-module_title.html +0 -0
  178. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-nested_modules.html +0 -0
  179. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-nesting.html +0 -0
  180. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-nesting_recursive.html +0 -0
  181. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-object_types.html +0 -0
  182. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-relative_resolve.html +0 -0
  183. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-roots-default.html +0 -0
  184. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-roots-no-roots.html +0 -0
  185. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-roots-single-root.html +0 -0
  186. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-settings-no-recursion.html +0 -0
  187. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/autodoc-settings-simple.html +0 -0
  188. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/doc-annotations.html +0 -0
  189. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/doc-autoindex.html +0 -0
  190. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/doc-directives.html +0 -0
  191. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/doc-inherited.html +0 -0
  192. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/doc-modules.html +0 -0
  193. {sphinx_lua_ls-3.5.0.post1 → sphinx_lua_ls-3.7.0}/test/test_regression/doc-refs.html +0 -0
@@ -0,0 +1,7 @@
1
+ # yaml-language-server: $schema=https://cl-keeper.readthedocs.io/en/latest/schema.json
2
+ version_format: python
3
+ ignore_missing_releases_before: "1.0.0"
4
+ extra_change_categories_map:
5
+ '(?i)migrating': "migrating"
6
+ extra_change_categories:
7
+ migrating: ""
@@ -141,11 +141,6 @@ jobs:
141
141
  - name: Build project
142
142
  run: |
143
143
  python3 -m build .
144
- - name: Publish to test pypi
145
- uses: pypa/gh-action-pypi-publish@release/v1
146
- with:
147
- repository-url: https://test.pypi.org/legacy/
148
- attestations: false
149
144
  - name: Publish to pypi
150
145
  uses: pypa/gh-action-pypi-publish@release/v1
151
146
  with:
@@ -1,47 +1,59 @@
1
1
  # Changelog
2
2
 
3
- ## [unreleased]
3
+ ## [Unreleased]
4
4
 
5
- ## [3.5.0-post1]
5
+ ## [3.7.0] - 2025-11-14
6
+
7
+ - Fixed parsing of `@see` annotations with LuaLs backend.
8
+
9
+ - Fixed parsing of EmmyLua output after they removed `classDefaultCall` setting.
10
+
11
+ ## [3.6.0] - 2025-10-17
12
+
13
+ - Adjusted styles for links in object signatures to match those produced by python domain.
14
+
15
+ - Releases are no longer uploaded to test version of PyPi.
16
+
17
+ ## [3.5.0-post1] - 2025-10-03
6
18
 
7
19
  - Migrated documentation to Read the Docs.
8
20
 
9
21
  - Moved repository to [sphinx-contrib](https://github.com/sphinx-contrib) organization.
10
22
 
11
- ## [3.5.0]
23
+ ## [3.5.0] - 2025-10-03
12
24
 
13
25
  - Added `autodata`, `autoattribute`, `autoclass`, and other `auto*` directives.
14
26
 
15
- They work like `autoobject`, but apply their doctype to the documented object
16
- (if `!doctype` was set in source code, it shouldn't conflict with the used directive).
27
+ They work like `autoobject`, but apply their doctype to the documented object (if
28
+ `!doctype` was set in source code, it shouldn't conflict with the used directive).
17
29
 
18
- They also allow overriding object's signature, which may be useful when
19
- automatically generated signature is too long.
30
+ They also allow overriding object's signature, which may be useful when automatically
31
+ generated signature is too long.
20
32
 
21
- - Added `lua_ls_max_version` config option to safeguard against incompatible changes
22
- to documentation export format.
33
+ - Added `lua_ls_max_version` config option to safeguard against incompatible changes to
34
+ documentation export format.
23
35
 
24
36
  - Fixed a few more minor bugs in highlighting of Lua types.
25
37
 
26
- ## [3.4.0]
38
+ ## [3.4.0] - 2025-09-28
27
39
 
28
- - **Potential breaking change:** use `confdir` instead of `srcdir` as base path
29
- for `lua_ls_project_root`.
40
+ - **Potential breaking change:** use `confdir` instead of `srcdir` as base path for
41
+ `lua_ls_project_root`.
30
42
 
31
43
  Prior to this change, `lua_ls_project_root` was resolved relative to the directory
32
44
  containing source `.rst` files. Documentation, however, was saying that it's resolved
33
45
  relative to the directory with `conf.py`.
34
46
 
35
- This is not an issue, because in most projects `conf.py` and source `.rst` files
36
- are located in the same directory. Still, I've decided to be consistent with
37
- other Sphinx extensions and use `confdir` instead of `srcdir`.
47
+ This is not an issue, because in most projects `conf.py` and source `.rst` files are
48
+ located in the same directory. Still, I've decided to be consistent with other Sphinx
49
+ extensions and use `confdir` instead of `srcdir`.
38
50
 
39
- This is a breaking change, but I don't believe there are any projects that
40
- use separate `confdir` and `srcdir` (the only reason to do this is if you're
41
- hosting multiple documentation sites in the same repo.) For this reason,
42
- this change is released as a minor version change.
51
+ This is a breaking change, but I don't believe there are any projects that use separate
52
+ `confdir` and `srcdir` (the only reason to do this is if you're hosting multiple
53
+ documentation sites in the same repo.) For this reason, this change is released as a
54
+ minor version change.
43
55
 
44
- ## [3.3.0]
56
+ ## [3.3.0] - 2025-09-28
45
57
 
46
58
  - Added an option to extend list options (like `:exclude-members:`) without overriding
47
59
  defaults:
@@ -53,15 +65,13 @@
53
65
 
54
66
  Also added `:no-*:` options to ignore defaults.
55
67
 
56
- - Improved display of members which use types instead of names,
57
- i.e. `[<type>]` ([#19] by [@bkoropoff]).
68
+ - Improved display of members which use types instead of names, i.e. `[<type>]` ([#19] by
69
+ [@bkoropoff]).
58
70
 
59
71
  - Added a warning for situations when `lua_ls_project_directories` contains directories
60
72
  outside of the current VCS root.
61
73
 
62
- [#19]: https://github.com/sphinx-contrib/lua-ls/pull/19
63
-
64
- ## [3.2.0]
74
+ ## [3.2.0] - 2025-09-02
65
75
 
66
76
  - Updated a few dependencies. Most notably, restricted `sphinx` to `<9`.
67
77
 
@@ -71,30 +81,26 @@
71
81
 
72
82
  - Done some internal refactorings.
73
83
 
74
- [#18]: https://github.com/sphinx-contrib/lua-ls/pull/18
75
- [@bkoropoff]: https://github.com/bkoropoff
76
-
77
- ## [3.1.0]
84
+ ## [3.1.0] - 2025-08-21
78
85
 
79
86
  - Added pygments lexer for Lua that highlights documentation tags.
80
87
 
81
88
  - Added option to control maximum signature length before wrapping.
82
89
 
83
- - Sphinx's nitpicky mode will no longer emit warnings
84
- for cross-references in signatures.
90
+ - Sphinx's nitpicky mode will no longer emit warnings for cross-references in signatures.
85
91
 
86
92
  - Fixed generation of URL anchors to avoid duplicates.
87
93
 
88
94
  - Fixed some edge cases in parsing of type expressions.
89
95
 
90
- ## [3.0.0]
96
+ ## [3.0.0] - 2025-07-26
91
97
 
92
98
  - **Breaking change:** changed how `apidoc` generates file names to avoid collisions.
93
99
 
94
100
  - Supported [EmmyLua] as an alternative backend for documentation export.
95
101
 
96
- EmmyLua was recently re-implemented in Rust, and its new language server
97
- provides some substantial benefits:
102
+ EmmyLua was recently re-implemented in Rust, and its new language server provides some
103
+ substantial benefits:
98
104
 
99
105
  - it has stronger and more flexible type system,
100
106
  - it handles aliases and enums way better than LuaLs,
@@ -112,8 +118,8 @@
112
118
  .. lua:data:: [integer]: string
113
119
  ```
114
120
 
115
- - Added `:globals:` flag for the `lua:autoobject` directive. It will allow
116
- automatically documenting global variables defined in a module.
121
+ - Added `:globals:` flag for the `lua:autoobject` directive. It will allow automatically
122
+ documenting global variables defined in a module.
117
123
 
118
124
  - The `lua:autoindex` directive now lists globals defined in a module.
119
125
 
@@ -131,8 +137,8 @@
131
137
  .. lua:class:: Foo<T>
132
138
  ```
133
139
 
134
- - Improved linking to Lua language documentation to take into account
135
- whether an item is supported for the given Lua version.
140
+ - Improved linking to Lua language documentation to take into account whether an item is
141
+ supported for the given Lua version.
136
142
 
137
143
  - Added the `lua:lua` role to compensate for MySt not supporting default roles.
138
144
 
@@ -142,34 +148,31 @@
142
148
  Reference to a {lua}`logging.Logger.info`.
143
149
  ```
144
150
 
145
- - Added the `lua:other-inherited-members` directive and `:inherited-members-table:`
146
- flag for the `lua:autoobject` directive.
151
+ - Added the `lua:other-inherited-members` directive and `:inherited-members-table:` flag
152
+ for the `lua:autoobject` directive.
147
153
 
148
- These allow listing all members that were inherited by a class but weren't
149
- documented within the class body (see [#3]).
154
+ These allow listing all members that were inherited by a class but weren't documented
155
+ within the class body (see [#3]).
150
156
 
151
157
  - Supported markdown output for `apidoc`.
152
158
 
153
159
  - Added option to separate module members into their own files for `apidoc`.
154
160
 
155
- [EmmyLua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
156
- [#3]: https://github.com/sphinx-contrib/lua-ls/issues/3
157
-
158
161
  ### Migrating to 3.0.0
159
162
 
160
163
  - If you're using `apidoc`, you'll need to update links to your documentation.
161
164
 
162
- - You'll need to explicitly specify which language server to use
163
- by including `lua_ls_backend` to your `conf.py`.
165
+ - You'll need to explicitly specify which language server to use by including
166
+ `lua_ls_backend` to your `conf.py`.
164
167
 
165
- ## [2.0.1]
168
+ ## [2.0.1] - 2025-04-12
166
169
 
167
170
  - Fixed documentation not being rebuilt after changing lua source code.
168
171
 
169
- ## [2.0.0]
172
+ ## [2.0.0] - 2025-03-16
170
173
 
171
- - **Breaking change:** don't implicitly convert classes that're derived from `table`
172
- to modules. Users should use a `!doctype` comment instead.
174
+ - **Breaking change:** don't implicitly convert classes that're derived from `table` to
175
+ modules. Users should use a `!doctype` comment instead.
173
176
 
174
177
  - **Breaking change:** disallow nesting modules inside classes.
175
178
 
@@ -194,11 +197,13 @@ $1--- !doctype module
194
197
  $1--- @class $2
195
198
  ```
196
199
 
197
- Make sure that you only use `!doctype module` on the top-level
198
- tables that can be imported via `require`. On other objects,
199
- use `!doctype table` instead, otherwise you'll get errors that modules are not allowed within other objects.
200
+ Make sure that you only use `!doctype module` on the top-level tables that can be imported
201
+ via `require`. On other objects, use `!doctype table` instead, otherwise you'll get errors
202
+ that modules are not allowed within other objects.
200
203
 
201
- ## [1.1.0]
204
+ ## [2.0.0b0] - 2025-03-16
205
+
206
+ ## [1.1.0] - 2025-03-11
202
207
 
203
208
  - Added support for `!doc` and `!doctype` comments.
204
209
 
@@ -206,30 +211,50 @@ use `!doctype table` instead, otherwise you'll get errors that modules are not a
206
211
 
207
212
  - Allowed referring `lua:const` objects from `lua:attr` role.
208
213
 
209
- - Fixed a bug when default options would not properly propagate
210
- when using `lua:autoobject` with `:recurse:`.
214
+ - Fixed a bug when default options would not properly propagate when using
215
+ `lua:autoobject` with `:recurse:`.
211
216
 
212
- - Fixed a bug when `lua:autoobject` would deduce incorrect module paths
213
- when applied to non-toplevel modules.
217
+ - Fixed a bug when `lua:autoobject` would deduce incorrect module paths when applied to
218
+ non-toplevel modules.
214
219
 
215
220
  - Fixed a bug when docstring for a class would be used for undocumented function
216
221
  parameters that have this class as their type.
217
222
 
218
223
  - Fixed types when `lua:autoobject` would infer incorrect types for `data`.
219
224
 
220
- ## [1.0.0]
225
+ ## [1.0.0] - 2025-03-09
221
226
 
222
227
  Initial release.
223
228
 
224
- [unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0-post1...HEAD
225
- [3.5.0-post1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0...v3.5.0-post1
226
- [3.5.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.4.0...v3.5.0
227
- [3.4.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.3.0...v3.4.0
228
- [3.3.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.2.0...v3.3.0
229
- [3.2.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.1.0...v3.2.0
230
- [3.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.0.0...v3.1.0
231
- [3.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.1...v3.0.0
232
- [2.0.1]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.0...v2.0.1
233
- [2.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.1.0...v2.0.0
229
+ ## [0.0.4] - 2025-03-09
230
+
231
+ ## [0.0.3] - 2025-03-09
232
+
233
+ ## [0.0.2] - 2025-03-09
234
+
235
+ ## [0.0.1] - 2025-03-09
236
+
237
+ [#18]: https://github.com/sphinx-contrib/lua-ls/pull/18
238
+ [#19]: https://github.com/sphinx-contrib/lua-ls/pull/19
239
+ [#3]: https://github.com/sphinx-contrib/lua-ls/issues/3
240
+ [0.0.1]: https://github.com/sphinx-contrib/lua-ls/releases/tag/v0.0.1
241
+ [0.0.2]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.1...v0.0.2
242
+ [0.0.3]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.2...v0.0.3
243
+ [0.0.4]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.3...v0.0.4
244
+ [1.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.4...v1.0.0
234
245
  [1.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.0.0...v1.1.0
235
- [1.0.0]: https://github.com/sphinx-contrib/lua-ls/releases/tag/v1.0.0
246
+ [2.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.0b0...v2.0.0
247
+ [2.0.0b0]: https://github.com/sphinx-contrib/lua-ls/compare/v1.1.0...v2.0.0b0
248
+ [2.0.1]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.0...v2.0.1
249
+ [3.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.1...v3.0.0
250
+ [3.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.0.0...v3.1.0
251
+ [3.2.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.1.0...v3.2.0
252
+ [3.3.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.2.0...v3.3.0
253
+ [3.4.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.3.0...v3.4.0
254
+ [3.5.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.4.0...v3.5.0
255
+ [3.5.0-post1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0...v3.5.0-post1
256
+ [3.6.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.5.0-post1...v3.6.0
257
+ [3.7.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.6.0...v3.7.0
258
+ [@bkoropoff]: https://github.com/bkoropoff
259
+ [emmylua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
260
+ [unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.7.0...HEAD
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sphinx-lua-ls
3
- Version: 3.5.0.post1
3
+ Version: 3.7.0
4
4
  Summary: Automatic documentation generation via EmmyLua/LuaLs
5
5
  Author-email: Tamika Nomara <taminomara@gmail.com>
6
6
  License-Expression: MIT
@@ -228,7 +228,7 @@ Autodoc directives
228
228
  .. rst:directive:option:: class-doc-from: class | ctor | both | separate
229
229
 
230
230
  Specifies how to generate documentation for classes
231
- if :py:data:`class_default_function_name` is configured.
231
+ if :py:data:`lua_ls_class_default_function_name` is configured.
232
232
 
233
233
  Options are:
234
234
 
@@ -245,7 +245,7 @@ Autodoc directives
245
245
  .. rst:directive:option:: class-signature: bases | ctor | both | minimal
246
246
 
247
247
  Specifies how to generate signatures for classes
248
- if :py:data:`class_default_function_name` is configured.
248
+ if :py:data:`lua_ls_class_default_function_name` is configured.
249
249
 
250
250
  Options are:
251
251
 
@@ -89,7 +89,7 @@ Settings
89
89
  .. lua:autoobject:: foo
90
90
  :no-undoc-members:
91
91
 
92
- .. py:data:: class_default_function_name
92
+ .. py:data:: lua_ls_class_default_function_name
93
93
  :type: str
94
94
 
95
95
  Allows specifying which class method represents a class constructor.
@@ -98,22 +98,16 @@ Settings
98
98
  :rst:dir:`lua:autoobject:class-doc-from`
99
99
  and :rst:dir:`lua:autoobject:class-signature` options.
100
100
 
101
- If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
102
-
103
- .. py:data:: class_default_force_non_colon
101
+ .. py:data:: lua_ls_class_default_force_non_colon
104
102
  :type:
105
103
 
106
104
  If ``True``, Sphinx-LuaLs will remove ``self`` from class constructor's signature.
107
105
 
108
- If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
109
-
110
- .. py:data:: class_default_force_return_self
106
+ .. py:data:: lua_ls_class_default_force_return_self
111
107
  :type:
112
108
 
113
109
  If ``True``, Sphinx-LuaLs will replace class constructor's return type with ``self``.
114
110
 
115
- If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
116
-
117
111
  .. py:data:: lua_ls_lua_version
118
112
  :type: str
119
113
 
@@ -35,13 +35,13 @@ dev = [
35
35
  {include-group = "doc"},
36
36
  ]
37
37
  lint = [
38
- "black==25.9.0",
39
- "isort==6.0.1",
40
- "pre-commit==4.3.0",
38
+ "black==25.11.0",
39
+ "isort==7.0.0",
40
+ "pre-commit==4.4.0",
41
41
  ]
42
42
  test = [
43
- "pyright==1.1.405",
44
- "pytest==8.4.2",
43
+ "pyright==1.1.407",
44
+ "pytest==9.0.1",
45
45
  "sybil==9.2.0",
46
46
  "pytest-regressions==2.8.3",
47
47
  "beautifulsoup4==4.14.2",
@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
28
28
  commit_id: COMMIT_ID
29
29
  __commit_id__: COMMIT_ID
30
30
 
31
- __version__ = version = '3.5.0.post1'
32
- __version_tuple__ = version_tuple = (3, 5, 0, 'post1')
31
+ __version__ = version = '3.7.0'
32
+ __version_tuple__ = version_tuple = (3, 7, 0)
33
33
 
34
- __commit_id__ = commit_id = 'g2fb45db04'
34
+ __commit_id__ = commit_id = 'ge31f54a0d'
@@ -659,9 +659,9 @@ class AutodocDirectiveMixin(AutodocUtilsMixin):
659
659
 
660
660
  if self.root.require_type:
661
661
  typ = utils.normalize_type(self.root.require_type)
662
- ref_nodes, warn_nodes = sphinx_lua_ls.domain.LuaXRefRole()(
663
- "lua:obj", typ, typ, 0, self.state.inliner
664
- )
662
+ ref_nodes, warn_nodes = sphinx_lua_ls.domain.LuaXRefRole(
663
+ innernodeclass=sphinx.addnodes.desc_sig_name
664
+ )("lua:obj", typ, typ, 0, self.state.inliner)
665
665
  content_node += docutils.nodes.paragraph(
666
666
  "",
667
667
  "",
@@ -153,7 +153,7 @@ class DocstringMixin:
153
153
  else:
154
154
  rejected_see_lines.append(see_line)
155
155
  else:
156
- if match := re.match(
156
+ if match := re.search(
157
157
  r"""
158
158
  ^
159
159
  See:[ ]
@@ -169,6 +169,7 @@ class DocstringMixin:
169
169
  ):
170
170
  typ = match.group("type") or match.group("rejected_type")
171
171
  doc = match.group("doc") or match.group("rejected_doc") or ""
172
+ doc = doc.strip()
172
173
  if doc:
173
174
  doc = ": " + doc
174
175
  see_lines.append(f":lua:obj:`{typ}`{doc}")
@@ -961,8 +962,8 @@ class EmmyLuaParser(Parser):
961
962
  def parse(self, json, path: str | pathlib.Path):
962
963
  self.path = pathlib.Path(path).expanduser().resolve()
963
964
 
964
- class_default_config = json["config"]["runtime"]["classDefaultCall"]
965
- if class_default_config["functionName"]:
965
+ class_default_config = json["config"]["runtime"].get("classDefaultCall")
966
+ if class_default_config and class_default_config.get("functionName"):
966
967
  self.class_default_function_name = class_default_config["functionName"]
967
968
  self.class_default_force_non_colon = class_default_config["forceNonColon"]
968
969
  self.class_default_force_return_self = class_default_config[
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sphinx-lua-ls
3
- Version: 3.5.0.post1
3
+ Version: 3.7.0
4
4
  Summary: Automatic documentation generation via EmmyLua/LuaLs
5
5
  Author-email: Tamika Nomara <taminomara@gmail.com>
6
6
  License-Expression: MIT
@@ -1,3 +1,4 @@
1
+ .cl-keeper.yaml
1
2
  .gitignore
2
3
  .pre-commit-config.yaml
3
4
  .readthedocs.yaml
@@ -70,6 +71,7 @@ test/roots/test-autodoc-emmylua/lua/globals.lua
70
71
  test/roots/test-autodoc-emmylua/lua/globals_2.lua
71
72
  test/roots/test-autodoc-emmylua/lua/incongruent_export.lua
72
73
  test/roots/test-autodoc-emmylua/lua/member_ordering.lua
74
+ test/roots/test-autodoc-emmylua/lua/module_function.lua
73
75
  test/roots/test-autodoc-emmylua/lua/module_title.lua
74
76
  test/roots/test-autodoc-emmylua/lua/nested_modules.lua
75
77
  test/roots/test-autodoc-emmylua/lua/nesting.lua
@@ -85,6 +87,7 @@ test/roots/test-autodoc-emmylua/src/global_tables.rst
85
87
  test/roots/test-autodoc-emmylua/src/globals.rst
86
88
  test/roots/test-autodoc-emmylua/src/incongruent_export.rst
87
89
  test/roots/test-autodoc-emmylua/src/member_ordering.rst
90
+ test/roots/test-autodoc-emmylua/src/module_function.rst
88
91
  test/roots/test-autodoc-emmylua/src/module_title.rst
89
92
  test/roots/test-autodoc-emmylua/src/nested_modules.rst
90
93
  test/roots/test-autodoc-emmylua/src/nesting.rst
@@ -157,6 +160,7 @@ test/test_regression/autodoc-emmylua-globals.html
157
160
  test/test_regression/autodoc-emmylua-incongruent_export.html
158
161
  test/test_regression/autodoc-emmylua-index.html
159
162
  test/test_regression/autodoc-emmylua-member_ordering.html
163
+ test/test_regression/autodoc-emmylua-module_function.html
160
164
  test/test_regression/autodoc-emmylua-module_title.html
161
165
  test/test_regression/autodoc-emmylua-nested_modules.html
162
166
  test/test_regression/autodoc-emmylua-nesting.html
@@ -25,20 +25,27 @@ function annotations.annotation_async() end
25
25
  --- @deprecated
26
26
  function annotations.annotation_deprecated() end
27
27
 
28
+ --- Description.
28
29
  --- @see annotations text
29
30
  --- @deprecated
30
31
  function annotations.see_one() end
31
32
 
33
+ --- Description.
32
34
  --- @see xyz text
33
35
  --- @deprecated
34
36
  function annotations.see_one_broken() end
35
37
 
38
+ --- Description.
36
39
  --- @see annotations.annotation_private text 1
37
40
  --- @see annotations.annotation_protected text 2
38
41
  --- @deprecated
39
42
  function annotations.see_many() end
40
43
 
44
+ --- Description.
41
45
  --- @see xyz text 1
42
46
  --- @see abc text 2
43
47
  --- @deprecated
44
48
  function annotations.see_many_broken() end
49
+
50
+ --- @see load
51
+ function annotations.see_no_text() end
@@ -23,4 +23,6 @@ Annotations
23
23
 
24
24
  .. lua:autoobject:: see_many_broken
25
25
 
26
+ .. lua:autoobject:: see_no_text
27
+
26
28
  Ref: :lua:obj:`annotation_deprecated`.
@@ -5,3 +5,6 @@ author = "test"
5
5
  extensions = ["sphinx_lua_ls"]
6
6
  lua_ls_backend = "emmylua"
7
7
  lua_ls_project_root = "lua"
8
+ lua_ls_class_default_function_name = "__init"
9
+ lua_ls_class_default_force_non_colon = True
10
+ lua_ls_class_default_force_return_self = True
@@ -5,11 +5,13 @@ Test autodoc
5
5
 
6
6
  src/annotations.rst
7
7
  src/autoindex.rst
8
+ src/doctype.rst
8
9
  src/globals.rst
9
10
  src/global_tables.rst
10
11
  src/incongruent_export.rst
11
12
  src/member_ordering.rst
12
13
  src/module_title.rst
14
+ src/module_function.rst
13
15
  src/nested_modules.rst
14
16
  src/nesting_recursive.rst
15
17
  src/nesting.rst
@@ -34,12 +34,7 @@
34
34
  "requireLikeFunction": [],
35
35
  "frameworkVersions": [],
36
36
  "extensions": [],
37
- "requirePattern": [],
38
- "classDefaultCall": {
39
- "functionName": "__init",
40
- "forceNonColon": true,
41
- "forceReturnSelf": true
42
- }
37
+ "requirePattern": []
43
38
  },
44
39
  "workspace": {
45
40
  "ignoreDir": [],
@@ -0,0 +1,2 @@
1
+ --- Documentation.
2
+ return function() end
@@ -0,0 +1,6 @@
1
+ Module function
2
+ ===============
3
+
4
+ .. container:: regression
5
+
6
+ .. lua:autoobject:: module_function