sphinx-lua-ls 3.8.1__tar.gz → 3.10.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 (205) hide show
  1. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/.github/workflows/ci.yaml +5 -6
  2. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/.pre-commit-config.yaml +14 -0
  3. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/CHANGELOG.md +15 -1
  4. {sphinx_lua_ls-3.8.1/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.10.0}/PKG-INFO +1 -1
  5. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/settings.rst +3 -1
  6. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/pyproject.toml +17 -20
  7. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/__init__.py +18 -0
  8. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/_version.py +3 -3
  9. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/apidoc.py +4 -8
  10. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/autodoc.py +4 -0
  11. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/config.py +5 -3
  12. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/domain.py +21 -12
  13. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/inherited.py +1 -1
  14. sphinx_lua_ls-3.10.0/sphinx_lua_ls/nodes.py +23 -0
  15. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0/sphinx_lua_ls.egg-info}/PKG-INFO +1 -1
  16. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls.egg-info/SOURCES.txt +8 -0
  17. sphinx_lua_ls-3.10.0/test/roots/test-autodoc/index.rst +7 -0
  18. sphinx_lua_ls-3.10.0/test/roots/test-autodoc/src/unknown_object.rst +6 -0
  19. sphinx_lua_ls-3.10.0/test/roots/test-autodoc-disabled/conf.py +7 -0
  20. sphinx_lua_ls-3.10.0/test/roots/test-autodoc-disabled/index.rst +6 -0
  21. sphinx_lua_ls-3.10.0/test/roots/test-autodoc-emmylua/index.rst +7 -0
  22. sphinx_lua_ls-3.10.0/test/roots/test-doc/index.rst +7 -0
  23. sphinx_lua_ls-3.10.0/test/roots/test-intersphinx/Makefile +20 -0
  24. sphinx_lua_ls-3.10.0/test/roots/test-intersphinx/make.bat +35 -0
  25. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-annotations.html +0 -10
  26. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-annotations.html +0 -9
  27. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-doctype.html +0 -3
  28. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-global_tables.html +0 -2
  29. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-globals.html +0 -3
  30. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-incongruent_export.html +0 -2
  31. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-index.html +0 -4
  32. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-member_ordering.html +0 -20
  33. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-module_title.html +0 -2
  34. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-nested_modules.html +0 -1
  35. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-nesting.html +0 -10
  36. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-nesting_recursive.html +0 -24
  37. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-object_types.html +0 -26
  38. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-relative_resolve.html +0 -2
  39. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-require.html +0 -1
  40. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-signatures.html +0 -23
  41. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-using.html +0 -1
  42. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-globals.html +0 -3
  43. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-member_ordering.html +0 -20
  44. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-module_title.html +0 -2
  45. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-nested_modules.html +0 -1
  46. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-nesting.html +0 -10
  47. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-nesting_recursive.html +0 -24
  48. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-object_types.html +0 -26
  49. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-relative_resolve.html +0 -2
  50. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-roots-default.html +0 -2
  51. sphinx_lua_ls-3.10.0/test/test_regression/autodoc-roots-no-roots.html +2 -0
  52. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-roots-single-root.html +0 -1
  53. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-settings-no-recursion.html +0 -1
  54. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-settings-simple.html +0 -2
  55. sphinx_lua_ls-3.10.0/test/test_regression/autodoc-unknown_object.html +2 -0
  56. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/doc-annotations.html +0 -2
  57. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/doc-directives.html +0 -62
  58. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/doc-inherited.html +0 -1
  59. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/doc-modules.html +0 -7
  60. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/doc-refs.html +0 -7
  61. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression.py +52 -12
  62. sphinx_lua_ls-3.8.1/test/roots/test-autodoc/index.rst +0 -15
  63. sphinx_lua_ls-3.8.1/test/roots/test-autodoc-emmylua/index.rst +0 -22
  64. sphinx_lua_ls-3.8.1/test/roots/test-doc/index.rst +0 -11
  65. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/.cl-keeper.yaml +0 -0
  66. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/.github/dependabot.yml +0 -0
  67. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/.gitignore +0 -0
  68. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/.readthedocs.yaml +0 -0
  69. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/CONTRIBUTING.md +0 -0
  70. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/LICENSE +0 -0
  71. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/README.md +0 -0
  72. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/conftest.py +0 -0
  73. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/Makefile +0 -0
  74. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/make.bat +0 -0
  75. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/_extra/robots.txt +0 -0
  76. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/apidoc.rst +0 -0
  77. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/autodoc.rst +0 -0
  78. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/conf.py +0 -0
  79. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/directives.rst +0 -0
  80. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/example/.emmyrc.json +0 -0
  81. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/example/logging.lua +0 -0
  82. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/example.rst +0 -0
  83. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/index.rst +0 -0
  84. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/installation.rst +0 -0
  85. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/quickstart.rst +0 -0
  86. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/docs/source/roles.rst +0 -0
  87. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/setup.cfg +0 -0
  88. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/autoindex.py +0 -0
  89. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/intersphinx.py +0 -0
  90. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/lua_ls.py +0 -0
  91. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/objtree.py +0 -0
  92. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/py.typed +0 -0
  93. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/pygments.py +0 -0
  94. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/static/lua.css +0 -0
  95. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls/utils.py +0 -0
  96. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls.egg-info/dependency_links.txt +0 -0
  97. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls.egg-info/requires.txt +0 -0
  98. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/sphinx_lua_ls.egg-info/top_level.txt +0 -0
  99. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/conftest.py +0 -0
  100. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-apidoc/.gitignore +0 -0
  101. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-apidoc/Makefile +0 -0
  102. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-apidoc/conf.py +0 -0
  103. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-apidoc/index.rst +0 -0
  104. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-apidoc/lua/mod/inner.lua +0 -0
  105. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-apidoc/lua/mod.lua +0 -0
  106. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-apidoc/make.bat +0 -0
  107. {sphinx_lua_ls-3.8.1/test/roots/test-doc → sphinx_lua_ls-3.10.0/test/roots/test-autodoc}/Makefile +0 -0
  108. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/conf.py +0 -0
  109. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/lua/annotations.lua +0 -0
  110. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/lua/globals.lua +0 -0
  111. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/lua/globals_2.lua +0 -0
  112. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/lua/member_ordering.lua +0 -0
  113. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/lua/module_title.lua +0 -0
  114. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/lua/nested_modules.lua +0 -0
  115. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/lua/nesting.lua +0 -0
  116. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/lua/object_types.lua +0 -0
  117. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/lua/relative_resolve.lua +0 -0
  118. {sphinx_lua_ls-3.8.1/test/roots/test-doc → sphinx_lua_ls-3.10.0/test/roots/test-autodoc}/make.bat +0 -0
  119. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/annotations.rst +0 -0
  120. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/autoindex.rst +0 -0
  121. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/globals.rst +0 -0
  122. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/member_ordering.rst +0 -0
  123. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/module_title.rst +0 -0
  124. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/nested_modules.rst +0 -0
  125. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/nesting.rst +0 -0
  126. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/nesting_recursive.rst +0 -0
  127. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/object_types.rst +0 -0
  128. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc/src/relative_resolve.rst +0 -0
  129. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc-emmylua → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-disabled}/Makefile +0 -0
  130. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc-emmylua → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-disabled}/make.bat +0 -0
  131. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc-roots → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-emmylua}/Makefile +0 -0
  132. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/conf.py +0 -0
  133. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/.emmyrc.json +0 -0
  134. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/annotations.lua +0 -0
  135. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/doctype.lua +0 -0
  136. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/foo/x.lua +0 -0
  137. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/global_tables.lua +0 -0
  138. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/globals.lua +0 -0
  139. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/globals_2.lua +0 -0
  140. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/incongruent_export.lua +0 -0
  141. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/member_ordering.lua +0 -0
  142. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/module_function.lua +0 -0
  143. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/module_title.lua +0 -0
  144. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/nested_modules.lua +0 -0
  145. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/nesting.lua +0 -0
  146. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/object_types.lua +0 -0
  147. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/relative_resolve.lua +0 -0
  148. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/signatures.lua +0 -0
  149. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/lua/using.lua +0 -0
  150. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc-roots → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-emmylua}/make.bat +0 -0
  151. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/annotations.rst +0 -0
  152. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/autoindex.rst +0 -0
  153. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/doctype.rst +0 -0
  154. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/global_tables.rst +0 -0
  155. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/globals.rst +0 -0
  156. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/incongruent_export.rst +0 -0
  157. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/member_ordering.rst +0 -0
  158. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/module_function.rst +0 -0
  159. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/module_title.rst +0 -0
  160. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/nested_modules.rst +0 -0
  161. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/nesting.rst +0 -0
  162. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/nesting_recursive.rst +0 -0
  163. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/object_types.rst +0 -0
  164. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/relative_resolve.rst +0 -0
  165. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/require.rst +0 -0
  166. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/signatures.rst +0 -0
  167. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-emmylua/src/using.rst +0 -0
  168. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc-settings-override → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-roots}/Makefile +0 -0
  169. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-roots/conf.py +0 -0
  170. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-roots/index.rst +0 -0
  171. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-roots/lua/root_1/autodoc.lua +0 -0
  172. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-roots/lua/root_2/autodoc.lua +0 -0
  173. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc-settings-override → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-roots}/make.bat +0 -0
  174. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-settings}/Makefile +0 -0
  175. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-settings/conf.py +0 -0
  176. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-settings/index.rst +0 -0
  177. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-settings/lua/autodoc.lua +0 -0
  178. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-settings}/make.bat +0 -0
  179. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc-settings → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-settings-override}/Makefile +0 -0
  180. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-settings-override/conf.py +0 -0
  181. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-settings-override/index.rst +0 -0
  182. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-autodoc-settings-override/lua/autodoc.lua +0 -0
  183. {sphinx_lua_ls-3.8.1/test/roots/test-autodoc-settings → sphinx_lua_ls-3.10.0/test/roots/test-autodoc-settings-override}/make.bat +0 -0
  184. {sphinx_lua_ls-3.8.1/test/roots/test-intersphinx → sphinx_lua_ls-3.10.0/test/roots/test-doc}/Makefile +0 -0
  185. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-doc/conf.py +0 -0
  186. {sphinx_lua_ls-3.8.1/test/roots/test-intersphinx → sphinx_lua_ls-3.10.0/test/roots/test-doc}/make.bat +0 -0
  187. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-doc/src/annotations.rst +0 -0
  188. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-doc/src/autoindex.rst +0 -0
  189. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-doc/src/directives.rst +0 -0
  190. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-doc/src/inherited.rst +0 -0
  191. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-doc/src/modules.rst +0 -0
  192. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-doc/src/refs.rst +0 -0
  193. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-intersphinx/conf.py +0 -0
  194. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/roots/test-intersphinx/index.rst +0 -0
  195. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_parse.py +0 -0
  196. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/apidoc-md-sep.yml +0 -0
  197. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/apidoc-md.yml +0 -0
  198. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/apidoc-rst-sep.yml +0 -0
  199. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/apidoc-rst.yml +0 -0
  200. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-autoindex.html +0 -0
  201. /sphinx_lua_ls-3.8.1/test/test_regression/autodoc-roots-no-roots.html → /sphinx_lua_ls-3.10.0/test/test_regression/autodoc-disabled-index.html +0 -0
  202. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-autoindex.html +0 -0
  203. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/autodoc-emmylua-module_function.html +0 -0
  204. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_regression/doc-autoindex.html +0 -0
  205. {sphinx_lua_ls-3.8.1 → sphinx_lua_ls-3.10.0}/test/test_versions.py +0 -0
@@ -126,13 +126,12 @@ jobs:
126
126
  ref="${{ github.ref }}";
127
127
  version=${ref#refs/tags/v};
128
128
  link="https://pypi.org/p/sphinx-lua-ls/${version}";
129
- echo "version=${version}" >> $GITHUB_OUTPUT
130
129
  echo "link=${link}" >> $GITHUB_OUTPUT
131
130
  - name: Parse Changelog
132
131
  id: changelog
133
- uses: mindsers/changelog-reader-action@v2
132
+ uses: taminomara/cl-keeper@v0
134
133
  with:
135
- version: ${{ steps.metadata.outputs.version }}
134
+ version: ${{ github.ref }}
136
135
  - name: Set up python 3.12
137
136
  uses: actions/setup-python@v4
138
137
  with:
@@ -150,11 +149,11 @@ jobs:
150
149
  - name: Create GitHub release
151
150
  uses: softprops/action-gh-release@v2
152
151
  with:
153
- prerelease: ${{ steps.changelog.outputs.status == 'prereleased' }}
154
- draft: ${{ steps.changelog.outputs.status == 'unreleased' }}
152
+ prerelease: ${{ fromJSON(steps.changelog.outputs.is-pre-release) }}
153
+ draft: ${{ fromJSON(steps.changelog.outputs.is-unreleased) }}
155
154
  body: |
156
155
  ## Changelog
157
156
 
158
- ${{ steps.changelog.outputs.changes }}
157
+ ${{ steps.changelog.outputs.text }}
159
158
 
160
159
  [See release on PyPi](${{ steps.metadata.outputs.link }})
@@ -13,6 +13,20 @@ repos:
13
13
  entry: isort --filter-files
14
14
  types_or: [python, pyi]
15
15
  require_serial: true
16
+ - id: clk
17
+ name: changelog keeper
18
+ language: system
19
+ entry: clk pre-commit-check
20
+ require_serial: true
21
+ types_or: [toml, yaml, markdown]
22
+ - id: clk-tags
23
+ name: changelog keeper (check tags)
24
+ language: system
25
+ entry: clk pre-commit-check-tag
26
+ always_run: true
27
+ pass_filenames: false
28
+ require_serial: true
29
+ stages: [pre-push]
16
30
  - repo: https://github.com/pre-commit/pre-commit-hooks
17
31
  rev: v6.0.0
18
32
  hooks:
@@ -2,6 +2,15 @@
2
2
 
3
3
  ## [Unreleased]
4
4
 
5
+ ## [3.10.0] - 2026-01-29
6
+
7
+ - Added option to disable running lua-ls (`lua_ls_backend = "disable"`) for cases when
8
+ only manual documentation is required ([#47] by [@pieterlexis]).
9
+
10
+ ## [3.9.0] - 2026-01-23
11
+
12
+ - Fixed LaTeX build and improved rendering of multiline signatures in LaTeX ([#46]).
13
+
5
14
  ## [3.8.1] - 2025-12-08
6
15
 
7
16
  - Added LuaLs 3.16.0 to the list of known broken releases ([LuaLS#3301]).
@@ -250,6 +259,8 @@ Initial release.
250
259
  [#18]: https://github.com/sphinx-contrib/lua-ls/pull/18
251
260
  [#19]: https://github.com/sphinx-contrib/lua-ls/pull/19
252
261
  [#3]: https://github.com/sphinx-contrib/lua-ls/issues/3
262
+ [#46]: https://github.com/sphinx-contrib/lua-ls/issues/46
263
+ [#47]: https://github.com/sphinx-contrib/lua-ls/pull/47
253
264
  [0.0.1]: https://github.com/sphinx-contrib/lua-ls/releases/tag/v0.0.1
254
265
  [0.0.2]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.1...v0.0.2
255
266
  [0.0.3]: https://github.com/sphinx-contrib/lua-ls/compare/v0.0.2...v0.0.3
@@ -260,6 +271,7 @@ Initial release.
260
271
  [2.0.1]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.0...v2.0.1
261
272
  [3.0.0]: https://github.com/sphinx-contrib/lua-ls/compare/v2.0.1...v3.0.0
262
273
  [3.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.0.0...v3.1.0
274
+ [3.10.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.9.0...v3.10.0
263
275
  [3.2.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.1.0...v3.2.0
264
276
  [3.3.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.2.0...v3.3.0
265
277
  [3.4.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.3.0...v3.4.0
@@ -270,7 +282,9 @@ Initial release.
270
282
  [3.7.0-post1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.7.0...v3.7.0-post1
271
283
  [3.8.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.7.0-post1...v3.8.0
272
284
  [3.8.1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.8.0...v3.8.1
285
+ [3.9.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.8.1...v3.9.0
273
286
  [@bkoropoff]: https://github.com/bkoropoff
287
+ [@pieterlexis]: https://github.com/pieterlexis
274
288
  [emmylua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
275
289
  [luals#3301]: https://github.com/LuaLS/lua-language-server/issues/3301
276
- [unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.8.1...HEAD
290
+ [unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.10.0...HEAD
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sphinx-lua-ls
3
- Version: 3.8.1
3
+ Version: 3.10.0
4
4
  Summary: Automatic documentation generation via EmmyLua/LuaLs
5
5
  Author-email: Tamika Nomara <taminomara@gmail.com>
6
6
  License-Expression: MIT
@@ -18,7 +18,9 @@ Settings
18
18
  .. py:data:: lua_ls_backend
19
19
  :type: str
20
20
 
21
- Controls which lua analyzer is used. Can be either ``"emmylua"`` or ``"luals"``.
21
+ Controls which lua analyzer is used. Can be either ``"emmylua"``, ``"luals"``, or ``"disable"``.
22
+ When set to ``"disable"``, no Lua files are analyzed, all language server related settings
23
+ are ignored, and :doc:`autodoc` does not work.
22
24
 
23
25
  .. py:data:: lua_ls_auto_install
24
26
  :type: bool
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "sphinx-lua-ls"
3
- authors = [{name = "Tamika Nomara", email = "taminomara@gmail.com"}]
3
+ authors = [{ name = "Tamika Nomara", email = "taminomara@gmail.com" }]
4
4
  description = "Automatic documentation generation via EmmyLua/LuaLs"
5
5
  dynamic = ["version"]
6
6
  readme = "README.md"
@@ -21,37 +21,34 @@ classifiers = [
21
21
  "Topic :: Documentation :: Sphinx",
22
22
  "Typing :: Typed",
23
23
  ]
24
- dependencies = [
25
- "sphinx>=8.0,<10.0",
26
- "PyGithub>=1.59,<3.0",
27
- "requests~=2.31",
28
- ]
24
+ dependencies = ["sphinx>=8.0,<10.0", "PyGithub>=1.59,<3.0", "requests~=2.31"]
29
25
 
30
26
  [dependency-groups]
31
27
  dev = [
32
28
  "pytest-cov==7.0.0",
33
- {include-group = "test"},
34
- {include-group = "lint"},
35
- {include-group = "doc"},
29
+ { include-group = "test" },
30
+ { include-group = "lint" },
31
+ { include-group = "doc" },
36
32
  ]
37
33
  lint = [
38
- "black==25.11.0",
34
+ "black==26.1.0",
39
35
  "isort==7.0.0",
40
- "pre-commit==4.5.0",
36
+ "pre-commit==4.5.1",
37
+ "cl-keeper==0.0.0-b6",
41
38
  ]
42
39
  test = [
43
- "pyright==1.1.407",
44
- "pytest==9.0.1",
45
- "sybil==9.2.0",
46
- "pytest-regressions==2.8.3",
40
+ "pyright==1.1.408",
41
+ "pytest==9.0.2",
42
+ "sybil==9.3.0",
43
+ "pytest-regressions==2.9.1",
47
44
  "beautifulsoup4==4.14.3",
48
- "myst-parser==4.0.1"
45
+ "myst-parser==5.0.0",
49
46
  ]
50
47
  doc = [
51
- "sybil==9.2.0",
52
- "furo==2025.9.25",
53
- "sphinx_design==0.6.1",
54
- "myst-parser==4.0.1"
48
+ "sybil==9.3.0",
49
+ "furo==2025.12.19",
50
+ "sphinx_design==0.7.0",
51
+ "myst-parser==5.0.0",
55
52
  ]
56
53
 
57
54
  [project.urls]
@@ -21,6 +21,7 @@ import sphinx_lua_ls.domain
21
21
  import sphinx_lua_ls.inherited
22
22
  import sphinx_lua_ls.intersphinx
23
23
  import sphinx_lua_ls.lua_ls
24
+ import sphinx_lua_ls.nodes
24
25
  import sphinx_lua_ls.objtree
25
26
  import sphinx_lua_ls.utils
26
27
  from sphinx_lua_ls._version import __version__, __version_tuple__
@@ -32,6 +33,9 @@ logger = logging.getLogger("sphinx_lua_ls")
32
33
  def run_lua_ls(app: sphinx.application.Sphinx):
33
34
  domain: sphinx_lua_ls.domain.LuaDomain = app.env.get_domain("lua") # type: ignore
34
35
 
36
+ if domain.config.backend == "disable":
37
+ return
38
+
35
39
  root_dir = domain.config.project_root
36
40
  project_directories = domain.config.project_directories
37
41
  if project_directories is None:
@@ -129,6 +133,12 @@ def run_apidoc(
129
133
  app: sphinx.application.Sphinx,
130
134
  ):
131
135
  domain = _t.cast(sphinx_lua_ls.domain.LuaDomain, app.env.get_domain("lua"))
136
+ if domain.config.backend == "disable":
137
+ logger.warning(
138
+ "apidoc requested, but the language server backend is disabled",
139
+ type="lua-ls",
140
+ )
141
+ return
132
142
  cwd = pathlib.Path.cwd()
133
143
  for name, params in domain.config.apidoc_roots.items():
134
144
  try:
@@ -259,6 +269,14 @@ def setup(app: sphinx.application.Sphinx):
259
269
 
260
270
  app.add_css_file("lua.css")
261
271
 
272
+ app.add_node(
273
+ sphinx_lua_ls.nodes.SigIndentNode,
274
+ latex=(
275
+ sphinx_lua_ls.nodes.visit_sig_indent_latex,
276
+ sphinx_lua_ls.nodes.depart_sig_indent_latex,
277
+ ),
278
+ )
279
+
262
280
  return {
263
281
  "version": __version__,
264
282
  "parallel_read_safe": True,
@@ -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.8.1'
32
- __version_tuple__ = version_tuple = (3, 8, 1)
31
+ __version__ = version = '3.10.0'
32
+ __version_tuple__ = version_tuple = (3, 10, 0)
33
33
 
34
- __commit_id__ = commit_id = 'g03b365db2'
34
+ __commit_id__ = commit_id = 'g73d8efc53'
@@ -22,8 +22,7 @@ _ENV.filters["h2"] = lambda title: f"{title}\n{'-' * len(title)}" # type: ignor
22
22
  _ENV.filters["h3"] = lambda title: f"{title}\n{'~' * len(title)}" # type: ignore
23
23
  _ENV.filters["mangle"] = lambda name: _mangle_filename(name) # type: ignore
24
24
 
25
- _TEMPLATE_RST = _ENV.from_string(
26
- """{{ title | h1 }}
25
+ _TEMPLATE_RST = _ENV.from_string("""{{ title | h1 }}
27
26
 
28
27
  .. lua:currentmodule:: {{ parent_modname }}
29
28
 
@@ -39,11 +38,9 @@ _TEMPLATE_RST = _ENV.from_string(
39
38
  {{ child_fullname | mangle }}.rst
40
39
  {% endfor %}
41
40
  {% endif %}
42
- """.lstrip()
43
- )
41
+ """.lstrip())
44
42
 
45
- _TEMPLATE_MD = _ENV.from_string(
46
- """# {{ title }}
43
+ _TEMPLATE_MD = _ENV.from_string("""# {{ title }}
47
44
 
48
45
  ```{lua:currentmodule} {{ parent_modname }}
49
46
  ```
@@ -62,8 +59,7 @@ _TEMPLATE_MD = _ENV.from_string(
62
59
  {% endfor %}
63
60
  ```
64
61
  {% endif %}
65
- """.lstrip()
66
- )
62
+ """.lstrip())
67
63
 
68
64
 
69
65
  def generate(
@@ -1069,6 +1069,10 @@ class AutoObjectDirective(AutodocUtilsMixin):
1069
1069
  doctype_override: str | None = None
1070
1070
 
1071
1071
  def run(self):
1072
+ if self.lua_domain.config.backend == "disable":
1073
+ raise self.error(
1074
+ "autoobject requested but the Lua language server is disabled"
1075
+ )
1072
1076
  self.prepare_options()
1073
1077
 
1074
1078
  signatures: list[str] = []
@@ -20,7 +20,7 @@ A = _t.ParamSpec("A")
20
20
  @dataclass
21
21
  class LuaDomainConfig:
22
22
  project_root: pathlib.Path
23
- backend: _t.Literal["emmylua", "luals"] = "luals"
23
+ backend: _t.Literal["emmylua", "luals", "disable"] = "luals"
24
24
  project_directories: list[pathlib.Path] | None = None
25
25
  auto_install: bool = True
26
26
  auto_install_location: pathlib.Path | None = None
@@ -188,9 +188,11 @@ def set_options(app: sphinx.application.Sphinx):
188
188
 
189
189
  if config["lua_ls_backend"] is not None:
190
190
  domain_config.backend = _t.cast(
191
- _t.Literal["emmylua", "luals"],
191
+ _t.Literal["emmylua", "luals", "disable"],
192
192
  _str_choices(
193
- "lua_ls_backend", config["lua_ls_backend"], ["luals", "emmylua"]
193
+ "lua_ls_backend",
194
+ config["lua_ls_backend"],
195
+ ["luals", "emmylua", "disable"],
194
196
  ),
195
197
  )
196
198
  else:
@@ -29,6 +29,7 @@ from sphinx.util.docutils import SphinxDirective
29
29
  from sphinx.util.nodes import make_id, make_refnode
30
30
 
31
31
  import sphinx_lua_ls.config
32
+ import sphinx_lua_ls.nodes
32
33
  import sphinx_lua_ls.objtree
33
34
  from sphinx_lua_ls import utils
34
35
 
@@ -49,18 +50,23 @@ class _SigWriter:
49
50
  ) -> None:
50
51
  self._signode = signode
51
52
  self._maximum_signature_line_length = maximum_signature_line_length
52
- signode["is_multiline"] = True
53
-
54
- self._line = addnodes.desc_signature_line(add_permalink=True)
55
- signode += self._line
53
+ self._line = self._signode
56
54
 
57
55
  def br(self):
58
- self._line["add_permalink"] = False
59
- self._line = addnodes.desc_signature_line(add_permalink=True)
60
- self._signode += self._line
56
+ if self._signode.get("is_multiline"):
57
+ self._line["add_permalink"] = False
58
+ self._line = addnodes.desc_signature_line(add_permalink=True)
59
+ self._signode += self._line
60
+ else:
61
+ self._signode["is_multiline"] = True
62
+ self._line = addnodes.desc_signature_line("", "", *self._signode.children)
63
+ self._signode.clear()
64
+ self._signode += self._line
65
+ self._line = addnodes.desc_signature_line(add_permalink=True)
66
+ self._signode += self._line
61
67
 
62
- def ident(self):
63
- self._line += addnodes.desc_sig_space(" ", " ")
68
+ def indent(self):
69
+ self._line += sphinx_lua_ls.nodes.SigIndentNode()
64
70
 
65
71
  def name(self, txt: str):
66
72
  self._line += addnodes.desc_sig_name(txt, txt)
@@ -120,7 +126,7 @@ class _SigWriter:
120
126
  for i, (arg, typ) in enumerate(params):
121
127
  if multiline:
122
128
  self.br()
123
- self.ident()
129
+ self.indent()
124
130
 
125
131
  if handle_optionals and arg and typ and typ.endswith("?"):
126
132
  arg, typ = arg + "?", typ[:-1]
@@ -165,7 +171,7 @@ class _SigWriter:
165
171
  for i, typ in enumerate(params):
166
172
  if multiline:
167
173
  self.br()
168
- self.ident()
174
+ self.indent()
169
175
 
170
176
  if typ:
171
177
  self.typ(typ, inliner)
@@ -486,7 +492,10 @@ class LuaObject(
486
492
  ) -> str:
487
493
  *prefix_parts, _ = fullname.split(".")
488
494
  prefix = ".".join(prefix_parts)
489
- return f"{name} ({self.objtype} in {prefix})"
495
+ if prefix:
496
+ return f"{name} ({self.objtype} in {prefix})"
497
+ else:
498
+ return f"{name} ({self.objtype})"
490
499
 
491
500
  def add_target_and_index(
492
501
  self,
@@ -59,7 +59,7 @@ class InheritedMembersTransform(SphinxTransform):
59
59
 
60
60
  bases = [(base, data) for base in data.bases]
61
61
  while bases:
62
- (base, data) = bases.pop()
62
+ base, data = bases.pop()
63
63
 
64
64
  resolved_base = self.domain._find_obj(
65
65
  data.base_lookup_modname or "",
@@ -0,0 +1,23 @@
1
+ from typing import Any
2
+
3
+ from docutils import nodes
4
+ from sphinx import addnodes
5
+
6
+
7
+ class SigIndentNode(addnodes.desc_sig_space):
8
+ def __init__(
9
+ self,
10
+ rawsource: str = "",
11
+ text: str = " ",
12
+ *children: nodes.Element,
13
+ **attributes: Any,
14
+ ):
15
+ super().__init__(rawsource, text, *children, **attributes)
16
+
17
+
18
+ def visit_sig_indent_latex(self, node):
19
+ self.body.append("~~~~")
20
+
21
+
22
+ def depart_sig_indent_latex(self, node):
23
+ pass
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: sphinx-lua-ls
3
- Version: 3.8.1
3
+ Version: 3.10.0
4
4
  Summary: Automatic documentation generation via EmmyLua/LuaLs
5
5
  Author-email: Tamika Nomara <taminomara@gmail.com>
6
6
  License-Expression: MIT
@@ -35,6 +35,7 @@ sphinx_lua_ls/domain.py
35
35
  sphinx_lua_ls/inherited.py
36
36
  sphinx_lua_ls/intersphinx.py
37
37
  sphinx_lua_ls/lua_ls.py
38
+ sphinx_lua_ls/nodes.py
38
39
  sphinx_lua_ls/objtree.py
39
40
  sphinx_lua_ls/py.typed
40
41
  sphinx_lua_ls/pygments.py
@@ -60,6 +61,10 @@ test/roots/test-autodoc/Makefile
60
61
  test/roots/test-autodoc/conf.py
61
62
  test/roots/test-autodoc/index.rst
62
63
  test/roots/test-autodoc/make.bat
64
+ test/roots/test-autodoc-disabled/Makefile
65
+ test/roots/test-autodoc-disabled/conf.py
66
+ test/roots/test-autodoc-disabled/index.rst
67
+ test/roots/test-autodoc-disabled/make.bat
63
68
  test/roots/test-autodoc-emmylua/Makefile
64
69
  test/roots/test-autodoc-emmylua/conf.py
65
70
  test/roots/test-autodoc-emmylua/index.rst
@@ -133,6 +138,7 @@ test/roots/test-autodoc/src/nesting.rst
133
138
  test/roots/test-autodoc/src/nesting_recursive.rst
134
139
  test/roots/test-autodoc/src/object_types.rst
135
140
  test/roots/test-autodoc/src/relative_resolve.rst
141
+ test/roots/test-autodoc/src/unknown_object.rst
136
142
  test/roots/test-doc/Makefile
137
143
  test/roots/test-doc/conf.py
138
144
  test/roots/test-doc/index.rst
@@ -153,6 +159,7 @@ test/test_regression/apidoc-rst-sep.yml
153
159
  test/test_regression/apidoc-rst.yml
154
160
  test/test_regression/autodoc-annotations.html
155
161
  test/test_regression/autodoc-autoindex.html
162
+ test/test_regression/autodoc-disabled-index.html
156
163
  test/test_regression/autodoc-emmylua-annotations.html
157
164
  test/test_regression/autodoc-emmylua-autoindex.html
158
165
  test/test_regression/autodoc-emmylua-doctype.html
@@ -184,6 +191,7 @@ test/test_regression/autodoc-roots-no-roots.html
184
191
  test/test_regression/autodoc-roots-single-root.html
185
192
  test/test_regression/autodoc-settings-no-recursion.html
186
193
  test/test_regression/autodoc-settings-simple.html
194
+ test/test_regression/autodoc-unknown_object.html
187
195
  test/test_regression/doc-annotations.html
188
196
  test/test_regression/doc-autoindex.html
189
197
  test/test_regression/doc-directives.html
@@ -0,0 +1,7 @@
1
+ Test autodoc
2
+ ============
3
+
4
+ .. toctree::
5
+ :glob:
6
+
7
+ src/*
@@ -0,0 +1,6 @@
1
+ Unknown object
2
+ ==============
3
+
4
+ .. container:: regression
5
+
6
+ .. lua:autoobject:: unknown_module.UnknownObject
@@ -0,0 +1,7 @@
1
+ project = "Test"
2
+ copyright = "test"
3
+ author = "test"
4
+
5
+ extensions = ["sphinx_lua_ls"]
6
+ lua_ls_backend = "disable"
7
+ lua_ls_apidoc_roots = {"mod": "api"}
@@ -0,0 +1,6 @@
1
+ Test autodoc
2
+ ============
3
+
4
+ .. container:: regression
5
+
6
+ .. lua:autoobject:: SomeObject
@@ -0,0 +1,7 @@
1
+ Test autodoc
2
+ ============
3
+
4
+ .. toctree::
5
+ :glob:
6
+
7
+ src/*
@@ -0,0 +1,7 @@
1
+ Test documentation
2
+ ==================
3
+
4
+ .. toctree::
5
+ :glob:
6
+
7
+ src/*
@@ -0,0 +1,20 @@
1
+ # Minimal makefile for Sphinx documentation
2
+ #
3
+
4
+ # You can set these variables from the command line, and also
5
+ # from the environment for the first two.
6
+ SPHINXOPTS ?=
7
+ SPHINXBUILD ?= sphinx-build
8
+ SOURCEDIR = .
9
+ BUILDDIR = build
10
+
11
+ # Put it first so that "make" without argument is like "make help".
12
+ help:
13
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14
+
15
+ .PHONY: help Makefile
16
+
17
+ # Catch-all target: route all unknown targets to Sphinx using the new
18
+ # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19
+ %: Makefile
20
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@@ -0,0 +1,35 @@
1
+ @ECHO OFF
2
+
3
+ pushd %~dp0
4
+
5
+ REM Command file for Sphinx documentation
6
+
7
+ if "%SPHINXBUILD%" == "" (
8
+ set SPHINXBUILD=sphinx-build
9
+ )
10
+ set SOURCEDIR=.
11
+ set BUILDDIR=build
12
+
13
+ %SPHINXBUILD% >NUL 2>NUL
14
+ if errorlevel 9009 (
15
+ echo.
16
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
17
+ echo.installed, then set the SPHINXBUILD environment variable to point
18
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
19
+ echo.may add the Sphinx directory to PATH.
20
+ echo.
21
+ echo.If you don't have Sphinx installed, grab it from
22
+ echo.https://www.sphinx-doc.org/
23
+ exit /b 1
24
+ )
25
+
26
+ if "%1" == "" goto help
27
+
28
+ %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
29
+ goto end
30
+
31
+ :help
32
+ %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
33
+
34
+ :end
35
+ popd
@@ -33,7 +33,6 @@
33
33
  <a class="headerlink" href="#lua-annotations.annotation_private" title="Link to this definition">
34
34
 
35
35
  </a>
36
- <br/>
37
36
  </dt>
38
37
  <dd>
39
38
  <p>
@@ -77,7 +76,6 @@
77
76
  <a class="headerlink" href="#lua-annotations.annotation_protected" title="Link to this definition">
78
77
 
79
78
  </a>
80
- <br/>
81
79
  </dt>
82
80
  <dd>
83
81
  <p>
@@ -121,7 +119,6 @@
121
119
  <a class="headerlink" href="#lua-annotations.annotation_package" title="Link to this definition">
122
120
 
123
121
  </a>
124
- <br/>
125
122
  </dt>
126
123
  <dd>
127
124
  <p>
@@ -165,7 +162,6 @@
165
162
  <a class="headerlink" href="#lua-annotations.annotation_async" title="Link to this definition">
166
163
 
167
164
  </a>
168
- <br/>
169
165
  </dt>
170
166
  <dd>
171
167
  <p>
@@ -200,7 +196,6 @@
200
196
  <a class="headerlink" href="#lua-annotations.annotation_deprecated" title="Link to this definition">
201
197
 
202
198
  </a>
203
- <br/>
204
199
  </dt>
205
200
  <dd>
206
201
  <p>
@@ -235,7 +230,6 @@
235
230
  <a class="headerlink" href="#lua-annotations.see_one" title="Link to this definition">
236
231
 
237
232
  </a>
238
- <br/>
239
233
  </dt>
240
234
  <dd>
241
235
  <p>
@@ -281,7 +275,6 @@
281
275
  <a class="headerlink" href="#lua-annotations.see_one_broken" title="Link to this definition">
282
276
 
283
277
  </a>
284
- <br/>
285
278
  </dt>
286
279
  <dd>
287
280
  <p>
@@ -325,7 +318,6 @@
325
318
  <a class="headerlink" href="#lua-annotations.see_many" title="Link to this definition">
326
319
 
327
320
  </a>
328
- <br/>
329
321
  </dt>
330
322
  <dd>
331
323
  <p>
@@ -389,7 +381,6 @@
389
381
  <a class="headerlink" href="#lua-annotations.see_many_broken" title="Link to this definition">
390
382
 
391
383
  </a>
392
- <br/>
393
384
  </dt>
394
385
  <dd>
395
386
  <p>
@@ -449,7 +440,6 @@
449
440
  <a class="headerlink" href="#lua-annotations.see_no_text" title="Link to this definition">
450
441
 
451
442
  </a>
452
- <br/>
453
443
  </dt>
454
444
  <dd>
455
445
  <p>