sphinx-lua-ls 3.10.1__tar.gz → 3.12.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.
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/.cl-keeper.yaml +2 -0
- sphinx_lua_ls-3.12.0/.coveragerc.toml +22 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/.github/dependabot.yml +16 -6
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/.github/workflows/ci.yaml +60 -27
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/.pre-commit-config.yaml +8 -7
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/CHANGELOG.md +14 -1
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/CONTRIBUTING.md +8 -7
- {sphinx_lua_ls-3.10.1/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.12.0}/PKG-INFO +2 -1
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/Makefile +8 -4
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/conf.py +1 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/index.rst +1 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/settings.rst +7 -0
- sphinx_lua_ls-3.12.0/docs/source/troubleshooring.rst +78 -0
- sphinx_lua_ls-3.12.0/poe_tasks.toml +60 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/pyproject.toml +37 -28
- sphinx_lua_ls-3.12.0/pytest.toml +4 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/__init__.py +12 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/_version.py +3 -3
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/apidoc.py +7 -2
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/autodoc.py +18 -6
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/config.py +15 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/objtree.py +21 -87
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0/sphinx_lua_ls.egg-info}/PKG-INFO +2 -1
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls.egg-info/SOURCES.txt +3 -1
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/tox.toml +22 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/uv.lock +360 -471
- sphinx_lua_ls-3.10.1/poe_tasks.toml +0 -31
- sphinx_lua_ls-3.10.1/scripts/resolve_venv.sh +0 -9
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/.gitignore +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/.readthedocs.yaml +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/LICENSE +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/README.md +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/conftest.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/_extra/robots.txt +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/apidoc.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/autodoc.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/directives.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/example/.emmyrc.json +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/example/logging.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/example.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/installation.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/quickstart.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/docs/source/roles.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/setup.cfg +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/autoindex.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/domain.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/inherited.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/intersphinx.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/lua_ls.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/nodes.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/py.typed +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/pygments.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/static/lua.css +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls/utils.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls.egg-info/dependency_links.txt +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls.egg-info/requires.txt +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/sphinx_lua_ls.egg-info/top_level.txt +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/__init__.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/conftest.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-apidoc/.gitignore +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-apidoc/Makefile +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-apidoc/conf.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-apidoc/index.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-apidoc/lua/mod/inner.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-apidoc/lua/mod.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-apidoc/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/Makefile +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/conf.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/index.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/lua/annotations.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/lua/globals.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/lua/globals_2.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/lua/member_ordering.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/lua/module_title.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/lua/nested_modules.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/lua/nesting.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/lua/object_types.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/lua/relative_resolve.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/annotations.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/autoindex.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/globals.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/member_ordering.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/module_title.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/nested_modules.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/nesting.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/nesting_recursive.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/object_types.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/relative_resolve.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc/src/unknown_object.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-disabled/Makefile +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-disabled/conf.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-disabled/index.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-disabled/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/Makefile +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/conf.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/index.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/.emmyrc.json +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/annotations.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/doctype.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/foo/x.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/global_tables.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/globals.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/globals_2.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/incongruent_export.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/member_ordering.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/module_function.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/module_title.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/nested_modules.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/nesting.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/object_types.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/relative_resolve.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/signatures.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/lua/using.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/annotations.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/autoindex.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/doctype.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/global_tables.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/globals.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/incongruent_export.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/member_ordering.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/module_function.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/module_title.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/nested_modules.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/nesting.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/nesting_recursive.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/object_types.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/relative_resolve.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/require.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/signatures.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-emmylua/src/using.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-roots/Makefile +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-roots/conf.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-roots/index.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-roots/lua/root_1/autodoc.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-roots/lua/root_2/autodoc.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-roots/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings/Makefile +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings/conf.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings/index.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings/lua/autodoc.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings-override/Makefile +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings-override/conf.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings-override/index.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings-override/lua/autodoc.lua +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-autodoc-settings-override/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/Makefile +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/conf.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/index.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/src/annotations.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/src/autoindex.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/src/directives.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/src/inherited.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/src/modules.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-doc/src/refs.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-intersphinx/Makefile +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-intersphinx/conf.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-intersphinx/index.rst +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/roots/test-intersphinx/make.bat +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_parse.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/apidoc-md-sep.yml +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/apidoc-md.yml +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/apidoc-rst-sep.yml +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/apidoc-rst.yml +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-annotations.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-autoindex.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-disabled-index.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-annotations.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-autoindex.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-doctype.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-global_tables.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-globals.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-incongruent_export.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-index.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-member_ordering.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-module_function.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-module_title.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-nested_modules.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-nesting.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-nesting_recursive.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-object_types.html +4 -4
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-relative_resolve.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-require.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-signatures.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-emmylua-using.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-globals.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-member_ordering.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-module_title.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-nested_modules.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-nesting.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-nesting_recursive.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-object_types.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-relative_resolve.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-roots-default.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-roots-no-roots.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-roots-single-root.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-settings-no-recursion.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-settings-simple.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/autodoc-unknown_object.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/doc-annotations.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/doc-autoindex.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/doc-directives.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/doc-inherited.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/doc-modules.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression/doc-refs.html +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_regression.py +0 -0
- {sphinx_lua_ls-3.10.1 → sphinx_lua_ls-3.12.0}/test/test_versions.py +0 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
[run]
|
|
2
|
+
relative_files = true
|
|
3
|
+
|
|
4
|
+
[report]
|
|
5
|
+
include = ["sphinx_lua_ls/**/*.py"]
|
|
6
|
+
omit = [
|
|
7
|
+
"sphinx_lua_ls/_version.py",
|
|
8
|
+
"test/**/*.py",
|
|
9
|
+
]
|
|
10
|
+
exclude_also = [
|
|
11
|
+
"def __repr__",
|
|
12
|
+
"def __rich_repr__",
|
|
13
|
+
"raise NotImplementedError",
|
|
14
|
+
"if __name__ == .__main__.:",
|
|
15
|
+
"if (|_t\\.|typing\\.)TYPE_CHECKING:",
|
|
16
|
+
"@(abc\\.)?abstractmethod",
|
|
17
|
+
"except ImportError:",
|
|
18
|
+
"assert False",
|
|
19
|
+
]
|
|
20
|
+
|
|
21
|
+
[html]
|
|
22
|
+
title = "Sphinx-LuaLs Coverage Report"
|
|
@@ -10,20 +10,30 @@ updates:
|
|
|
10
10
|
- "beautifulsoup4"
|
|
11
11
|
- "furo"
|
|
12
12
|
- "myst-parser"
|
|
13
|
+
- "PyGithub"
|
|
13
14
|
- "pyright"
|
|
14
|
-
- "pytest_image_diff"
|
|
15
15
|
- "pytest-cov"
|
|
16
16
|
- "pytest-regressions"
|
|
17
17
|
- "pytest"
|
|
18
|
-
- "
|
|
18
|
+
- "requests"
|
|
19
19
|
- "sphinx_design"
|
|
20
|
-
- "
|
|
20
|
+
- "sphinx-autobuild"
|
|
21
|
+
- "sphinx"
|
|
21
22
|
- "sybil"
|
|
23
|
+
- "tox"
|
|
24
|
+
- "tox-uv"
|
|
22
25
|
style:
|
|
23
26
|
patterns:
|
|
24
|
-
- "
|
|
25
|
-
- "
|
|
26
|
-
|
|
27
|
+
- "prek"
|
|
28
|
+
- "ruff"
|
|
29
|
+
- package-ecosystem: "pre-commit"
|
|
30
|
+
directory: "/"
|
|
31
|
+
schedule:
|
|
32
|
+
interval: "weekly"
|
|
33
|
+
groups:
|
|
34
|
+
pre-commit:
|
|
35
|
+
patterns:
|
|
36
|
+
- "*"
|
|
27
37
|
- package-ecosystem: "github-actions"
|
|
28
38
|
directory: "/"
|
|
29
39
|
schedule:
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
name:
|
|
1
|
+
name: test
|
|
2
2
|
on:
|
|
3
3
|
push:
|
|
4
4
|
branches:
|
|
@@ -8,7 +8,10 @@ on:
|
|
|
8
8
|
pull_request:
|
|
9
9
|
branches:
|
|
10
10
|
- main
|
|
11
|
+
|
|
11
12
|
jobs:
|
|
13
|
+
# Downloads LuaLs and EmmyLua binaries for all OSes and uploads them as an
|
|
14
|
+
# artifact so that the test job can re-use them without re-downloading.
|
|
12
15
|
prepare:
|
|
13
16
|
name: Download LuaLs
|
|
14
17
|
runs-on: ubuntu-latest
|
|
@@ -44,6 +47,10 @@ jobs:
|
|
|
44
47
|
path: ~/lua_ls_release
|
|
45
48
|
include-hidden-files: true
|
|
46
49
|
retention-days: 3
|
|
50
|
+
|
|
51
|
+
# Runs main tests for the package.
|
|
52
|
+
#
|
|
53
|
+
# Runs on all events except when closing a pull request.
|
|
47
54
|
test:
|
|
48
55
|
name: Test package
|
|
49
56
|
needs:
|
|
@@ -81,25 +88,28 @@ jobs:
|
|
|
81
88
|
path: ~/lua_ls_release
|
|
82
89
|
- name: Test package
|
|
83
90
|
if: ${{ matrix.type == 'test' }}
|
|
84
|
-
run:
|
|
91
|
+
run: |
|
|
92
|
+
poe ci
|
|
85
93
|
env:
|
|
86
94
|
LUA_LS_CACHE_PATH: ~/lua_ls_release/${{ matrix.os }}
|
|
87
95
|
# Lint
|
|
88
96
|
- name: Check code style
|
|
89
97
|
if: ${{ matrix.type == 'code style' }}
|
|
90
|
-
run:
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
98
|
+
run: |
|
|
99
|
+
poe lint --color always
|
|
100
|
+
|
|
101
|
+
# Builds python packages.
|
|
102
|
+
#
|
|
103
|
+
# Only runs on tag pushes.
|
|
104
|
+
build:
|
|
105
|
+
name: Build package
|
|
95
106
|
if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}
|
|
96
107
|
runs-on: ubuntu-latest
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
id-token: write
|
|
108
|
+
outputs:
|
|
109
|
+
link: ${{ steps.metadata.outputs.link }}
|
|
110
|
+
is-pre-release: ${{ steps.changelog.outputs.is-pre-release }}
|
|
111
|
+
is-unreleased: ${{ steps.changelog.outputs.is-unreleased }}
|
|
112
|
+
changelog-text: ${{ steps.changelog.outputs.text }}
|
|
103
113
|
steps:
|
|
104
114
|
- name: Checkout source
|
|
105
115
|
uses: actions/checkout@v6
|
|
@@ -110,35 +120,58 @@ jobs:
|
|
|
110
120
|
run: |
|
|
111
121
|
ref="${{ github.ref }}";
|
|
112
122
|
version=${ref#refs/tags/v};
|
|
113
|
-
link="https://pypi.org/p/sphinx-lua-ls/${version}";
|
|
123
|
+
link="https://pypi.org/p/sphinx-lua-ls/${version}/";
|
|
114
124
|
echo "link=${link}" >> $GITHUB_OUTPUT
|
|
115
125
|
- name: Parse Changelog
|
|
116
126
|
id: changelog
|
|
117
127
|
uses: taminomara/cl-keeper@v1
|
|
118
128
|
with:
|
|
119
129
|
version: ${{ github.ref }}
|
|
120
|
-
- name:
|
|
121
|
-
uses:
|
|
122
|
-
with:
|
|
123
|
-
python-version: 3.12
|
|
124
|
-
- name: Install build
|
|
125
|
-
run: |
|
|
126
|
-
pip install build
|
|
130
|
+
- name: Install UV
|
|
131
|
+
uses: astral-sh/setup-uv@v7
|
|
127
132
|
- name: Build project
|
|
128
133
|
run: |
|
|
129
|
-
|
|
134
|
+
uv build
|
|
135
|
+
- name: Upload the build artifact
|
|
136
|
+
uses: actions/upload-artifact@v7
|
|
137
|
+
with:
|
|
138
|
+
name: python-package-distributions
|
|
139
|
+
path: dist/
|
|
140
|
+
|
|
141
|
+
# Publishes python packages.
|
|
142
|
+
#
|
|
143
|
+
# Only runs on tag pushes.
|
|
144
|
+
publish_to_pypi:
|
|
145
|
+
name: Publish package to PyPi
|
|
146
|
+
needs:
|
|
147
|
+
- test
|
|
148
|
+
- build
|
|
149
|
+
if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') }}
|
|
150
|
+
runs-on: ubuntu-latest
|
|
151
|
+
environment:
|
|
152
|
+
name: pypi
|
|
153
|
+
url: https://pypi.org/p/sphinx-lua-ls
|
|
154
|
+
permissions:
|
|
155
|
+
contents: write
|
|
156
|
+
id-token: write
|
|
157
|
+
steps:
|
|
158
|
+
- name: Download build artifact
|
|
159
|
+
uses: actions/download-artifact@v8
|
|
160
|
+
with:
|
|
161
|
+
name: python-package-distributions
|
|
162
|
+
path: dist/
|
|
130
163
|
- name: Publish to pypi
|
|
131
164
|
uses: pypa/gh-action-pypi-publish@release/v1
|
|
132
165
|
with:
|
|
133
166
|
attestations: false
|
|
134
167
|
- name: Create GitHub release
|
|
135
|
-
uses: softprops/action-gh-release@
|
|
168
|
+
uses: softprops/action-gh-release@v3
|
|
136
169
|
with:
|
|
137
|
-
prerelease: ${{ fromJSON(
|
|
138
|
-
draft: ${{ fromJSON(
|
|
170
|
+
prerelease: ${{ fromJSON(needs.build.outputs.is-pre-release) }}
|
|
171
|
+
draft: ${{ fromJSON(needs.build.outputs.is-unreleased) }}
|
|
139
172
|
body: |
|
|
140
173
|
## Changelog
|
|
141
174
|
|
|
142
|
-
${{
|
|
175
|
+
${{ needs.build.outputs.changelog-text }}
|
|
143
176
|
|
|
144
|
-
[See release on PyPi](${{
|
|
177
|
+
[See release on PyPi](${{ needs.build.outputs.link }})
|
|
@@ -4,26 +4,26 @@ repos:
|
|
|
4
4
|
- id: ruff-check
|
|
5
5
|
name: ruff check
|
|
6
6
|
language: system
|
|
7
|
-
entry:
|
|
7
|
+
entry: uv run --no-sync ruff check --force-exclude
|
|
8
8
|
types_or: [python, pyi]
|
|
9
9
|
require_serial: true
|
|
10
10
|
- id: ruff-format
|
|
11
11
|
name: ruff format
|
|
12
12
|
language: system
|
|
13
|
-
entry:
|
|
13
|
+
entry: uv run --no-sync ruff format --force-exclude
|
|
14
14
|
types_or: [python, pyi]
|
|
15
15
|
require_serial: true
|
|
16
|
+
- repo: https://github.com/taminomara/cl-keeper
|
|
17
|
+
rev: v1.0.0
|
|
18
|
+
hooks:
|
|
16
19
|
- id: clk
|
|
17
|
-
name: changelog keeper
|
|
18
|
-
language: system
|
|
19
|
-
entry: scripts/resolve_venv.sh clk pre-commit-check
|
|
20
|
-
require_serial: true
|
|
21
|
-
types_or: [toml, yaml, markdown]
|
|
22
20
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
23
21
|
rev: v6.0.0
|
|
24
22
|
hooks:
|
|
25
23
|
- id: trailing-whitespace
|
|
24
|
+
exclude: "^(test/roots/.*|mre-sphinx-lua/.*)$"
|
|
26
25
|
- id: end-of-file-fixer
|
|
26
|
+
exclude: "^(test/roots/.*|mre-sphinx-lua/.*)$"
|
|
27
27
|
- id: fix-byte-order-marker
|
|
28
28
|
- id: mixed-line-ending
|
|
29
29
|
args: [--fix=lf]
|
|
@@ -33,6 +33,7 @@ repos:
|
|
|
33
33
|
- id: check-json
|
|
34
34
|
- id: check-merge-conflict
|
|
35
35
|
- id: check-shebang-scripts-are-executable
|
|
36
|
+
- id: check-executables-have-shebangs
|
|
36
37
|
- id: check-symlinks
|
|
37
38
|
- id: destroyed-symlinks
|
|
38
39
|
- id: check-vcs-permalinks
|
|
@@ -2,6 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
## [Unreleased]
|
|
4
4
|
|
|
5
|
+
## [3.12.0] - 2026-05-12
|
|
6
|
+
|
|
7
|
+
- Bumped dependencies.
|
|
8
|
+
- Hardened build and publishing process to lower risk of supply-chain attacks.
|
|
9
|
+
|
|
10
|
+
## [3.11.0] - 2026-03-29
|
|
11
|
+
|
|
12
|
+
- Added config option to print debug logs: `lua_ls_verbose`.
|
|
13
|
+
- Improved error messages related to object lookup errors and added a troubleshooting
|
|
14
|
+
guide.
|
|
15
|
+
|
|
5
16
|
## [3.10.1] - 2026-03-29
|
|
6
17
|
|
|
7
18
|
- Fiexd broken cross-references on the search page.
|
|
@@ -277,6 +288,8 @@ Initial release.
|
|
|
277
288
|
[3.1.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.0.0...v3.1.0
|
|
278
289
|
[3.10.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.9.0...v3.10.0
|
|
279
290
|
[3.10.1]: https://github.com/sphinx-contrib/lua-ls/compare/v3.10.0...v3.10.1
|
|
291
|
+
[3.11.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.10.1...v3.11.0
|
|
292
|
+
[3.12.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.11.0...v3.12.0
|
|
280
293
|
[3.2.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.1.0...v3.2.0
|
|
281
294
|
[3.3.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.2.0...v3.3.0
|
|
282
295
|
[3.4.0]: https://github.com/sphinx-contrib/lua-ls/compare/v3.3.0...v3.4.0
|
|
@@ -292,4 +305,4 @@ Initial release.
|
|
|
292
305
|
[@pieterlexis]: https://github.com/pieterlexis
|
|
293
306
|
[emmylua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
|
|
294
307
|
[luals#3301]: https://github.com/LuaLS/lua-language-server/issues/3301
|
|
295
|
-
[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.
|
|
308
|
+
[unreleased]: https://github.com/sphinx-contrib/lua-ls/compare/v3.12.0...HEAD
|
|
@@ -9,7 +9,8 @@ We use [`uv`] and [`poe`] to run tasks, but it is possible to use pure pip as we
|
|
|
9
9
|
|
|
10
10
|
### Using pip
|
|
11
11
|
|
|
12
|
-
1. Create a virtual environment with python `3.
|
|
12
|
+
1. Create a virtual environment with python `3.13` or newer
|
|
13
|
+
(some of dev tools don't work with older pythons).
|
|
13
14
|
|
|
14
15
|
2. Make sure your pip is up to date:
|
|
15
16
|
|
|
@@ -61,10 +62,10 @@ We use [`uv`] and [`poe`] to run tasks, but it is possible to use pure pip as we
|
|
|
61
62
|
uv tool install poethepoet
|
|
62
63
|
```
|
|
63
64
|
|
|
64
|
-
|
|
65
|
+
4. If you're not on linux, install [EmmyLua Doc Cli].
|
|
65
66
|
|
|
66
67
|
|
|
67
|
-
## Run
|
|
68
|
+
## Run commands
|
|
68
69
|
|
|
69
70
|
We use `poe` for most of the tasks:
|
|
70
71
|
|
|
@@ -83,11 +84,11 @@ poe --help
|
|
|
83
84
|
|
|
84
85
|
## Build docs
|
|
85
86
|
|
|
86
|
-
|
|
87
|
+
To build docs, just use `poe`:
|
|
87
88
|
|
|
88
89
|
```shell
|
|
89
|
-
|
|
90
|
-
|
|
90
|
+
poe doc # Build HTML.
|
|
91
|
+
poe doc-watch # Run sphinx-autobuild.
|
|
91
92
|
```
|
|
92
93
|
|
|
93
94
|
Sphinx-LuaLs will download the latest version of Lua Language Server for you.
|
|
@@ -95,7 +96,7 @@ Sphinx-LuaLs will download the latest version of Lua Language Server for you.
|
|
|
95
96
|
|
|
96
97
|
## Release
|
|
97
98
|
|
|
98
|
-
1. Make sure that "Unreleased" section in `
|
|
99
|
+
1. Make sure that "Unreleased" section in `CHANGELOG.md` is up to date.
|
|
99
100
|
|
|
100
101
|
2. Run `poe release major|minor|patch` to bump version in changelog
|
|
101
102
|
and create a release tag.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: sphinx-lua-ls
|
|
3
|
-
Version: 3.
|
|
3
|
+
Version: 3.12.0
|
|
4
4
|
Summary: Automatic documentation generation via EmmyLua/LuaLs
|
|
5
5
|
Author-email: Tamika Nomara <taminomara@gmail.com>
|
|
6
6
|
License-Expression: MIT
|
|
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3 :: Only
|
|
|
13
13
|
Classifier: Programming Language :: Python :: 3
|
|
14
14
|
Classifier: Programming Language :: Python :: 3.12
|
|
15
15
|
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
16
17
|
Classifier: Intended Audience :: Developers
|
|
17
18
|
Classifier: Framework :: Sphinx
|
|
18
19
|
Classifier: Framework :: Sphinx :: Domain
|
|
@@ -3,18 +3,22 @@
|
|
|
3
3
|
|
|
4
4
|
# You can set these variables from the command line, and also
|
|
5
5
|
# from the environment for the first two.
|
|
6
|
-
SPHINXOPTS ?= -j
|
|
6
|
+
SPHINXOPTS ?= -j 12 -n
|
|
7
7
|
SPHINXBUILD ?= sphinx-build
|
|
8
8
|
SOURCEDIR = source
|
|
9
9
|
BUILDDIR = build
|
|
10
|
+
DOCTREEDIR = build/doctrees
|
|
10
11
|
|
|
11
12
|
# Put it first so that "make" without argument is like "make help".
|
|
12
13
|
help:
|
|
13
|
-
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
14
|
+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" -d "$(DOCTREEDIR)" $(SPHINXOPTS) $(O)
|
|
14
15
|
|
|
15
|
-
.PHONY: help Makefile
|
|
16
|
+
.PHONY: help watch Makefile
|
|
17
|
+
|
|
18
|
+
watch:
|
|
19
|
+
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)"/html -d "$(DOCTREEDIR)" --watch ../sphinx_lua_ls $(SPHINXOPTS) $(O)
|
|
16
20
|
|
|
17
21
|
# Catch-all target: route all unknown targets to Sphinx using the new
|
|
18
22
|
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
|
19
23
|
%: Makefile
|
|
20
|
-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
|
24
|
+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" -d "$(DOCTREEDIR)" $(SPHINXOPTS) $(O)
|
|
@@ -29,6 +29,7 @@ lua_ls_backend = "emmylua"
|
|
|
29
29
|
lua_ls_class_default_function_name = "__init"
|
|
30
30
|
lua_ls_class_default_force_non_colon = True
|
|
31
31
|
lua_ls_class_default_force_return_self = True
|
|
32
|
+
lua_ls_verbose = True
|
|
32
33
|
|
|
33
34
|
intersphinx_mapping = {
|
|
34
35
|
"python": ("https://docs.python.org/3", None),
|
|
@@ -244,3 +244,10 @@ Settings
|
|
|
244
244
|
to use Sphinx's global setting ``maximum_signature_line_length``.
|
|
245
245
|
If ``maximum_signature_line_length`` is also ``None``,
|
|
246
246
|
signature wrapping will be disabled.
|
|
247
|
+
|
|
248
|
+
.. py:data:: lua_ls_verbose
|
|
249
|
+
:type: bool
|
|
250
|
+
|
|
251
|
+
Prints debug logs from sphinx-lua-ls without raising verbosity level
|
|
252
|
+
of other Sphinx loggers. Set to ``True`` to see object tree discovered
|
|
253
|
+
by lua analyzer.
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
Troubleshooring
|
|
2
|
+
===============
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
Autodoc can't fund a module or object
|
|
6
|
+
-------------------------------------
|
|
7
|
+
|
|
8
|
+
1. Set ``lua_ls_verbose = True`` in ``conf.py`` and run build with ``-E`` (``make html O="-E"``).
|
|
9
|
+
|
|
10
|
+
#. Search build log for record ``Lua analysis finished. Found objects:`` and see
|
|
11
|
+
if object that can't be found appears in the object tree.
|
|
12
|
+
|
|
13
|
+
#. If it's there, check spelling and full path of the object. Error message will contain
|
|
14
|
+
all candidate paths that Sphinx-LuaLs tried when resolving it.
|
|
15
|
+
|
|
16
|
+
#. If it's not there, check your documentation markup, EmmyLua/LuaLs settings,
|
|
17
|
+
and project paths and directories:
|
|
18
|
+
|
|
19
|
+
.. tab-set::
|
|
20
|
+
:sync-group: backend
|
|
21
|
+
|
|
22
|
+
.. tab-item:: EmmyLua
|
|
23
|
+
:sync: emmylua
|
|
24
|
+
|
|
25
|
+
a. Check that :py:data:`lua_ls_project_root` and :py:data:`lua_ls_project_directories`
|
|
26
|
+
point to the right places.
|
|
27
|
+
|
|
28
|
+
You can see how Sphinx-LuaLs launched language server by grepping build
|
|
29
|
+
log for message ``running lua-language-server with args``.
|
|
30
|
+
|
|
31
|
+
#. Make sure that you have an explicit return at the end of a module.
|
|
32
|
+
|
|
33
|
+
If your module only sets global variables, return an empty table from it:
|
|
34
|
+
|
|
35
|
+
.. code-block:: lua
|
|
36
|
+
|
|
37
|
+
-- mod.lua
|
|
38
|
+
|
|
39
|
+
--- Module documentation.
|
|
40
|
+
return {}
|
|
41
|
+
|
|
42
|
+
#. Alternatively, if your module exports a global variable with the same name,
|
|
43
|
+
make sure to set its doctype:
|
|
44
|
+
|
|
45
|
+
.. code-block:: lua
|
|
46
|
+
|
|
47
|
+
-- mod.lua
|
|
48
|
+
|
|
49
|
+
--- Module documentation.
|
|
50
|
+
---
|
|
51
|
+
--- @doctype module
|
|
52
|
+
mod = {
|
|
53
|
+
-- Module contents.
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
#. Make sure that your project directories are listed in ``.emmyrc.json``
|
|
57
|
+
under ``workspace.workspaceRoots`` and not ``workspace.library``.
|
|
58
|
+
|
|
59
|
+
.. tab-item:: LuaLs
|
|
60
|
+
:sync: luals
|
|
61
|
+
|
|
62
|
+
a. Check that :py:data:`lua_ls_project_root` and :py:data:`lua_ls_project_directories`
|
|
63
|
+
point to the right places.
|
|
64
|
+
|
|
65
|
+
You can see how Sphinx-LuaLs launched language server by grepping build
|
|
66
|
+
log for message ``running lua-language-server with args``.
|
|
67
|
+
|
|
68
|
+
#. Make sure that you've created a class named after your module, and set its
|
|
69
|
+
doctype:
|
|
70
|
+
|
|
71
|
+
.. code-block:: lua
|
|
72
|
+
|
|
73
|
+
-- mod.lua
|
|
74
|
+
|
|
75
|
+
--- Module documentation.
|
|
76
|
+
---
|
|
77
|
+
--- !doctype module
|
|
78
|
+
--- @class mod
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
[executor]
|
|
2
|
+
type = "uv"
|
|
3
|
+
no-group = ["dev"]
|
|
4
|
+
|
|
5
|
+
[tasks.lint]
|
|
6
|
+
help = "Run pre-commit linters"
|
|
7
|
+
cmd = "prek run --all-files"
|
|
8
|
+
executor = { group = "lint" }
|
|
9
|
+
|
|
10
|
+
[tasks.test]
|
|
11
|
+
help = "Run tests"
|
|
12
|
+
cmd = "tox -e 3.14,coverage-combine --"
|
|
13
|
+
executor = { group = "ci" }
|
|
14
|
+
|
|
15
|
+
[tasks.test-all]
|
|
16
|
+
help = "Run tests for all pythons"
|
|
17
|
+
cmd = "tox p --"
|
|
18
|
+
executor = { group = "ci" }
|
|
19
|
+
|
|
20
|
+
[tasks.cov-clear]
|
|
21
|
+
help = "Erase coverage data (use this if you stop tests mid-flight)"
|
|
22
|
+
cmd = "coverage erase"
|
|
23
|
+
executor = { group = "test" }
|
|
24
|
+
|
|
25
|
+
[tasks._cov-html]
|
|
26
|
+
cmd = "coverage html -d htmlcov"
|
|
27
|
+
executor = { group = "test" }
|
|
28
|
+
|
|
29
|
+
[tasks._cov-html-serve]
|
|
30
|
+
cmd = "python -m http.server -b localhost 8081"
|
|
31
|
+
cwd = "htmlcov"
|
|
32
|
+
|
|
33
|
+
[tasks.test-cov]
|
|
34
|
+
help = "Run tests with coverage and serve HTML report on localhost:8081"
|
|
35
|
+
sequence = ["test", "_cov-html", "_cov-html-serve"]
|
|
36
|
+
|
|
37
|
+
[tasks.test-cov-all]
|
|
38
|
+
help = "Run tests for all pythons with coverage and serve HTML report on localhost:8081"
|
|
39
|
+
sequence = ["test-all", "_cov-html", "_cov-html-serve"]
|
|
40
|
+
|
|
41
|
+
[tasks.ci]
|
|
42
|
+
help = "For CI job"
|
|
43
|
+
cmd = "tox --colored yes p --skip-env lint --"
|
|
44
|
+
executor = { group = "ci" }
|
|
45
|
+
|
|
46
|
+
[tasks.doc]
|
|
47
|
+
help = "Build HTML docs"
|
|
48
|
+
cmd = "sphinx-build -b html docs/source docs/build/html -d docs/build/doctrees -j 12 -n"
|
|
49
|
+
executor = { group = "doc" }
|
|
50
|
+
|
|
51
|
+
[tasks.doc-watch]
|
|
52
|
+
help = "Start documentation server and rebuild HTML docs on every change"
|
|
53
|
+
cmd = "sphinx-autobuild docs/source docs/build/html -d docs/build/doctrees --watch . -j 12 -n"
|
|
54
|
+
executor = { group = "doc" }
|
|
55
|
+
|
|
56
|
+
[tasks.release]
|
|
57
|
+
help = "Bump version, create release commit and tag"
|
|
58
|
+
cmd = "uvx --from cl-keeper clk bump --commit"
|
|
59
|
+
use_exec = true
|
|
60
|
+
executor = { type = "simple" }
|
|
@@ -12,6 +12,7 @@ classifiers = [
|
|
|
12
12
|
"Programming Language :: Python :: 3",
|
|
13
13
|
"Programming Language :: Python :: 3.12",
|
|
14
14
|
"Programming Language :: Python :: 3.13",
|
|
15
|
+
"Programming Language :: Python :: 3.14",
|
|
15
16
|
"Intended Audience :: Developers",
|
|
16
17
|
"Framework :: Sphinx",
|
|
17
18
|
"Framework :: Sphinx :: Domain",
|
|
@@ -25,32 +26,35 @@ dependencies = ["sphinx>=8.0,<10.0", "PyGithub>=1.59,<3.0", "requests~=2.31"]
|
|
|
25
26
|
|
|
26
27
|
[dependency-groups]
|
|
27
28
|
dev = [
|
|
28
|
-
|
|
29
|
-
{ include-group = "test" },
|
|
30
|
-
{ include-group = "lint" },
|
|
29
|
+
{ include-group = "ci" },
|
|
31
30
|
{ include-group = "doc" },
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
"cl-keeper==1.0.0",
|
|
35
|
-
"prek==0.3.8",
|
|
36
|
-
"ruff==0.15.8",
|
|
31
|
+
{ include-group = "lint" },
|
|
32
|
+
{ include-group = "test" },
|
|
37
33
|
]
|
|
38
34
|
test = [
|
|
39
|
-
"pyright==1.1.408",
|
|
40
|
-
"pytest==9.0.2",
|
|
41
|
-
"sybil==10.0.1",
|
|
42
|
-
"pytest-regressions==2.10.0",
|
|
43
35
|
"beautifulsoup4==4.14.3",
|
|
44
36
|
"myst-parser==5.0.0",
|
|
45
|
-
"
|
|
46
|
-
"
|
|
37
|
+
"pyright==1.1.409",
|
|
38
|
+
"pytest-cov==7.1.0",
|
|
39
|
+
"pytest-regressions==2.10.0",
|
|
40
|
+
"pytest==9.0.3",
|
|
41
|
+
"sybil==10.0.1",
|
|
47
42
|
]
|
|
48
43
|
doc = [
|
|
49
|
-
"sybil==10.0.1",
|
|
50
44
|
"furo==2025.12.19",
|
|
51
|
-
"sphinx_design==0.7.0",
|
|
52
45
|
"myst-parser==5.0.0",
|
|
53
46
|
"sphinx-autobuild==2025.8.25",
|
|
47
|
+
"sphinx_design==0.7.0",
|
|
48
|
+
"sybil==10.0.1",
|
|
49
|
+
]
|
|
50
|
+
lint = [
|
|
51
|
+
"prek==0.3.13",
|
|
52
|
+
"ruff==0.15.12",
|
|
53
|
+
]
|
|
54
|
+
ci = [
|
|
55
|
+
"pytest-cov==7.1.0",
|
|
56
|
+
"tox==4.53.1",
|
|
57
|
+
"tox-uv==1.35.2",
|
|
54
58
|
]
|
|
55
59
|
|
|
56
60
|
[project.urls]
|
|
@@ -65,22 +69,19 @@ requires = ["setuptools>=60", "setuptools_scm[toml]>=8", "wheel>=0.40"]
|
|
|
65
69
|
[tool.setuptools_scm]
|
|
66
70
|
write_to = "sphinx_lua_ls/_version.py"
|
|
67
71
|
|
|
68
|
-
[tool.pytest.ini_options]
|
|
69
|
-
minversion = "7.0"
|
|
70
|
-
addopts = ["--strict-markers", "-p no:doctest"]
|
|
71
|
-
testpaths = ["test", "sphinx_lua_ls", "docs"]
|
|
72
|
-
|
|
73
72
|
[tool.pyright]
|
|
74
73
|
include = ["sphinx_lua_ls"]
|
|
75
|
-
exclude = [
|
|
74
|
+
exclude = [
|
|
75
|
+
"**/__pycache__",
|
|
76
|
+
"sphinx_lua_ls/_version.py",
|
|
77
|
+
"examples/docs/*",
|
|
78
|
+
"test/roots/*",
|
|
79
|
+
"mre-sphinx-lua/*",
|
|
80
|
+
]
|
|
76
81
|
typeCheckingMode = "strict"
|
|
77
|
-
pythonVersion = "3.
|
|
82
|
+
pythonVersion = "3.14"
|
|
78
83
|
pythonPlatform = "All"
|
|
79
84
|
|
|
80
|
-
# deprecateTypingAliases = true
|
|
81
|
-
reportUnnecessaryTypeIgnoreComment = "warning"
|
|
82
|
-
reportUnusedFunction = "none"
|
|
83
|
-
reportPrivateUsage = "none"
|
|
84
85
|
reportMissingParameterType = "none"
|
|
85
86
|
reportUnknownParameterType = "none"
|
|
86
87
|
reportUnknownVariableType = "none"
|
|
@@ -88,11 +89,16 @@ reportUnknownMemberType = "none"
|
|
|
88
89
|
reportUnknownArgumentType = "none"
|
|
89
90
|
reportUnknownLambdaType = "none"
|
|
90
91
|
reportUnnecessaryIsInstance = "none"
|
|
92
|
+
reportUnnecessaryTypeIgnoreComment = "warning"
|
|
93
|
+
reportPrivateUsage = "none"
|
|
94
|
+
reportUnusedFunction = "none"
|
|
91
95
|
reportConstantRedefinition = "none"
|
|
92
96
|
reportRedeclaration = "none"
|
|
97
|
+
reportDeprecated = "none"
|
|
98
|
+
deprecateTypingAliases = true
|
|
93
99
|
|
|
94
100
|
[tool.ruff]
|
|
95
|
-
exclude = ["examples/docs/*", "test/roots/*"]
|
|
101
|
+
exclude = ["examples/docs/*", "test/roots/*", "mre-sphinx-lua/*"]
|
|
96
102
|
target-version = "py312"
|
|
97
103
|
|
|
98
104
|
[tool.ruff.lint]
|
|
@@ -131,3 +137,6 @@ required-imports = ["from __future__ import annotations"]
|
|
|
131
137
|
|
|
132
138
|
[tool.ruff.format]
|
|
133
139
|
docstring-code-format = true
|
|
140
|
+
|
|
141
|
+
[tool.uv]
|
|
142
|
+
default-groups = ["dev"]
|