sphinx-lua-ls 3.4.0__tar.gz → 3.5.0.post1__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.4.0 → sphinx_lua_ls-3.5.0.post1}/.github/workflows/ci.yaml +1 -90
- sphinx_lua_ls-3.5.0.post1/.readthedocs.yaml +13 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/CHANGELOG.md +36 -13
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/CONTRIBUTING.md +18 -5
- {sphinx_lua_ls-3.4.0/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.5.0.post1}/PKG-INFO +9 -9
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/README.md +4 -4
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/autodoc.rst +56 -20
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/conf.py +1 -1
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/directives.rst +9 -6
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/example/logging.lua +6 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/index.rst +1 -1
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/settings.rst +15 -1
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/pyproject.toml +5 -5
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/__init__.py +44 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/_version.py +3 -3
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/apidoc.py +1 -1
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/autodoc.py +257 -66
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/config.py +7 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/domain.py +12 -7
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/lua_ls.py +100 -31
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/objtree.py +43 -35
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/utils.py +24 -16
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1/sphinx_lua_ls.egg-info}/PKG-INFO +9 -9
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls.egg-info/SOURCES.txt +4 -0
- sphinx_lua_ls-3.5.0.post1/test/roots/test-autodoc-emmylua/lua/doctype.lua +13 -0
- sphinx_lua_ls-3.5.0.post1/test/roots/test-autodoc-emmylua/src/doctype.rst +9 -0
- sphinx_lua_ls-3.5.0.post1/test/test_regression/autodoc-emmylua-doctype.html +153 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/doc-directives.html +0 -7
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression.py +1 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/.github/dependabot.yml +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/.gitignore +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/.pre-commit-config.yaml +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/LICENSE +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/conftest.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/Makefile +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/make.bat +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/_extra/robots.txt +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/apidoc.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/example/.emmyrc.json +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/example.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/installation.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/quickstart.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/docs/source/roles.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/setup.cfg +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/autoindex.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/inherited.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/intersphinx.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/py.typed +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/pygments.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls/static/lua.css +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls.egg-info/dependency_links.txt +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls.egg-info/requires.txt +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/sphinx_lua_ls.egg-info/top_level.txt +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/conftest.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-apidoc/.gitignore +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-apidoc/Makefile +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-apidoc/conf.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-apidoc/index.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-apidoc/lua/mod/inner.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-apidoc/lua/mod.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-apidoc/make.bat +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/Makefile +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/conf.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/index.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/lua/annotations.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/lua/globals.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/lua/globals_2.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/lua/member_ordering.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/lua/module_title.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/lua/nested_modules.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/lua/nesting.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/lua/object_types.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/lua/relative_resolve.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/make.bat +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/annotations.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/autoindex.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/globals.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/member_ordering.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/module_title.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/nested_modules.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/nesting.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/nesting_recursive.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/object_types.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc/src/relative_resolve.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/Makefile +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/conf.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/index.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/.emmyrc.json +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/annotations.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/foo/x.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/global_tables.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/globals.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/globals_2.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/incongruent_export.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/member_ordering.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/module_title.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/nested_modules.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/nesting.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/object_types.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/relative_resolve.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/signatures.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/lua/using.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/make.bat +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/annotations.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/autoindex.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/global_tables.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/globals.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/incongruent_export.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/member_ordering.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/module_title.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/nested_modules.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/nesting.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/nesting_recursive.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/object_types.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/relative_resolve.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/require.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/signatures.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-emmylua/src/using.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-roots/Makefile +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-roots/conf.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-roots/index.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-roots/lua/root_1/autodoc.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-roots/lua/root_2/autodoc.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-roots/make.bat +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings/Makefile +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings/conf.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings/index.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings/lua/autodoc.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings/make.bat +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings-override/Makefile +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings-override/conf.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings-override/index.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings-override/lua/autodoc.lua +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-autodoc-settings-override/make.bat +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/Makefile +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/conf.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/index.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/make.bat +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/src/annotations.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/src/autoindex.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/src/directives.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/src/inherited.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/src/modules.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-doc/src/refs.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-intersphinx/Makefile +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-intersphinx/conf.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-intersphinx/index.rst +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/roots/test-intersphinx/make.bat +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_parse.py +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/apidoc-md-sep.yml +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/apidoc-md.yml +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/apidoc-rst-sep.yml +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/apidoc-rst.yml +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-annotations.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-autoindex.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-annotations.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-autoindex.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-global_tables.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-globals.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-incongruent_export.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-index.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-member_ordering.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-module_title.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-nested_modules.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-nesting.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-nesting_recursive.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-object_types.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-relative_resolve.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-require.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-signatures.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-emmylua-using.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-globals.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-member_ordering.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-module_title.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-nested_modules.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-nesting.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-nesting_recursive.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-object_types.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-relative_resolve.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-roots-default.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-roots-no-roots.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-roots-single-root.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-settings-no-recursion.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/autodoc-settings-simple.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/doc-annotations.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/doc-autoindex.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/doc-inherited.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/doc-modules.html +0 -0
- {sphinx_lua_ls-3.4.0 → sphinx_lua_ls-3.5.0.post1}/test/test_regression/doc-refs.html +0 -0
|
@@ -8,17 +8,9 @@ on:
|
|
|
8
8
|
pull_request:
|
|
9
9
|
branches:
|
|
10
10
|
- main
|
|
11
|
-
types:
|
|
12
|
-
- opened
|
|
13
|
-
- reopened
|
|
14
|
-
- synchronize
|
|
15
|
-
- closed
|
|
16
|
-
|
|
17
11
|
jobs:
|
|
18
|
-
# Download LuaLs for all platforms all at once, to reduce total number of downloads.
|
|
19
12
|
prepare:
|
|
20
13
|
name: Download LuaLs
|
|
21
|
-
if: ${{ !(github.event_name == 'pull_request' && github.event.action == 'closed') }}
|
|
22
14
|
runs-on: ubuntu-latest
|
|
23
15
|
steps:
|
|
24
16
|
- name: Checkout source
|
|
@@ -52,15 +44,10 @@ jobs:
|
|
|
52
44
|
path: ~/lua_ls_release
|
|
53
45
|
include-hidden-files: true
|
|
54
46
|
retention-days: 3
|
|
55
|
-
|
|
56
|
-
# Runs main tests for the package.
|
|
57
|
-
#
|
|
58
|
-
# Runs on all events except when closing a pull request.
|
|
59
47
|
test:
|
|
60
48
|
name: Test package
|
|
61
49
|
needs:
|
|
62
50
|
- prepare
|
|
63
|
-
if: ${{ !(github.event_name == 'pull_request' && github.event.action == 'closed') }}
|
|
64
51
|
strategy:
|
|
65
52
|
fail-fast: false
|
|
66
53
|
matrix:
|
|
@@ -114,10 +101,6 @@ jobs:
|
|
|
114
101
|
- name: Check code style
|
|
115
102
|
if: ${{ matrix.type == 'code style' }}
|
|
116
103
|
run: pre-commit run -a
|
|
117
|
-
|
|
118
|
-
# Builds and publishes python packages.
|
|
119
|
-
#
|
|
120
|
-
# Only runs on tag pushes.
|
|
121
104
|
publish_to_pypi:
|
|
122
105
|
name: Publish package to PyPi
|
|
123
106
|
needs:
|
|
@@ -140,7 +123,7 @@ jobs:
|
|
|
140
123
|
run: |
|
|
141
124
|
ref="${{ github.ref }}";
|
|
142
125
|
version=${ref#refs/tags/v};
|
|
143
|
-
link="https://pypi.org/p/${
|
|
126
|
+
link="https://pypi.org/p/sphinx-lua-ls/${version}";
|
|
144
127
|
echo "version=${version}" >> $GITHUB_OUTPUT
|
|
145
128
|
echo "link=${link}" >> $GITHUB_OUTPUT
|
|
146
129
|
- name: Parse Changelog
|
|
@@ -178,75 +161,3 @@ jobs:
|
|
|
178
161
|
${{ steps.changelog.outputs.changes }}
|
|
179
162
|
|
|
180
163
|
[See release on PyPi](${{ steps.metadata.outputs.link }})
|
|
181
|
-
|
|
182
|
-
# Builds sphinx documentation.
|
|
183
|
-
#
|
|
184
|
-
# Runs on all events except when closing a pull request.
|
|
185
|
-
build_docs:
|
|
186
|
-
name: Build docs
|
|
187
|
-
needs:
|
|
188
|
-
- test
|
|
189
|
-
if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') && !contains(github.event.ref, '.dev') }}
|
|
190
|
-
runs-on: ubuntu-latest
|
|
191
|
-
steps:
|
|
192
|
-
- name: Checkout
|
|
193
|
-
uses: actions/checkout@v4
|
|
194
|
-
with:
|
|
195
|
-
fetch-depth: 0
|
|
196
|
-
- name: Set up python 3.12
|
|
197
|
-
uses: actions/setup-python@v4
|
|
198
|
-
with:
|
|
199
|
-
python-version: 3.12
|
|
200
|
-
- name: Install package
|
|
201
|
-
run: |
|
|
202
|
-
python -m pip install --upgrade pip
|
|
203
|
-
python -m pip install . --group doc
|
|
204
|
-
- name: Download LuaLs
|
|
205
|
-
uses: actions/download-artifact@v4
|
|
206
|
-
with:
|
|
207
|
-
name: lua_ls_release
|
|
208
|
-
path: ~/lua_ls_release
|
|
209
|
-
- name: Build docs
|
|
210
|
-
env:
|
|
211
|
-
SPHINXOPTS: "-j auto -n"
|
|
212
|
-
LUA_LS_CACHE_PATH: ~/lua_ls_release/ubuntu-latest
|
|
213
|
-
run: |
|
|
214
|
-
cd docs
|
|
215
|
-
make html
|
|
216
|
-
- name: Upload artifact
|
|
217
|
-
uses: actions/upload-artifact@v4
|
|
218
|
-
with:
|
|
219
|
-
name: html_output
|
|
220
|
-
path: docs/build/html
|
|
221
|
-
include-hidden-files: true
|
|
222
|
-
|
|
223
|
-
# Builds and publishes production docs.
|
|
224
|
-
#
|
|
225
|
-
# Only runs on tag pushes.
|
|
226
|
-
publish_docs:
|
|
227
|
-
name: Publish docs to GitHub Pages
|
|
228
|
-
needs:
|
|
229
|
-
- build_docs
|
|
230
|
-
if: ${{ github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags') && !contains(github.event.ref, '.dev') }}
|
|
231
|
-
concurrency:
|
|
232
|
-
group: publish-docs-${{ github.ref }}
|
|
233
|
-
cancel-in-progress: true
|
|
234
|
-
permissions: write-all
|
|
235
|
-
runs-on: ubuntu-latest
|
|
236
|
-
steps:
|
|
237
|
-
- name: Checkout
|
|
238
|
-
uses: actions/checkout@v4
|
|
239
|
-
with:
|
|
240
|
-
fetch-depth: 0
|
|
241
|
-
- name: Download artifact
|
|
242
|
-
uses: actions/download-artifact@v4
|
|
243
|
-
with:
|
|
244
|
-
name: html_output
|
|
245
|
-
path: docs/build/html
|
|
246
|
-
- name: Publish HTML
|
|
247
|
-
uses: JamesIves/github-pages-deploy-action@v4
|
|
248
|
-
with:
|
|
249
|
-
folder: docs/build/html
|
|
250
|
-
target-folder: .
|
|
251
|
-
clean-exclude: pr-preview
|
|
252
|
-
single-commit: false
|
|
@@ -2,6 +2,27 @@
|
|
|
2
2
|
|
|
3
3
|
## [unreleased]
|
|
4
4
|
|
|
5
|
+
## [3.5.0-post1]
|
|
6
|
+
|
|
7
|
+
- Migrated documentation to Read the Docs.
|
|
8
|
+
|
|
9
|
+
- Moved repository to [sphinx-contrib](https://github.com/sphinx-contrib) organization.
|
|
10
|
+
|
|
11
|
+
## [3.5.0]
|
|
12
|
+
|
|
13
|
+
- Added `autodata`, `autoattribute`, `autoclass`, and other `auto*` directives.
|
|
14
|
+
|
|
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).
|
|
17
|
+
|
|
18
|
+
They also allow overriding object's signature, which may be useful when
|
|
19
|
+
automatically generated signature is too long.
|
|
20
|
+
|
|
21
|
+
- Added `lua_ls_max_version` config option to safeguard against incompatible changes
|
|
22
|
+
to documentation export format.
|
|
23
|
+
|
|
24
|
+
- Fixed a few more minor bugs in highlighting of Lua types.
|
|
25
|
+
|
|
5
26
|
## [3.4.0]
|
|
6
27
|
|
|
7
28
|
- **Potential breaking change:** use `confdir` instead of `srcdir` as base path
|
|
@@ -38,7 +59,7 @@
|
|
|
38
59
|
- Added a warning for situations when `lua_ls_project_directories` contains directories
|
|
39
60
|
outside of the current VCS root.
|
|
40
61
|
|
|
41
|
-
[#19]: https://github.com/
|
|
62
|
+
[#19]: https://github.com/sphinx-contrib/lua-ls/pull/19
|
|
42
63
|
|
|
43
64
|
## [3.2.0]
|
|
44
65
|
|
|
@@ -50,7 +71,7 @@
|
|
|
50
71
|
|
|
51
72
|
- Done some internal refactorings.
|
|
52
73
|
|
|
53
|
-
[#18]: https://github.com/
|
|
74
|
+
[#18]: https://github.com/sphinx-contrib/lua-ls/pull/18
|
|
54
75
|
[@bkoropoff]: https://github.com/bkoropoff
|
|
55
76
|
|
|
56
77
|
## [3.1.0]
|
|
@@ -132,7 +153,7 @@
|
|
|
132
153
|
- Added option to separate module members into their own files for `apidoc`.
|
|
133
154
|
|
|
134
155
|
[EmmyLua]: https://github.com/EmmyLuaLs/emmylua-analyzer-rust/
|
|
135
|
-
[#3]: https://github.com/
|
|
156
|
+
[#3]: https://github.com/sphinx-contrib/lua-ls/issues/3
|
|
136
157
|
|
|
137
158
|
### Migrating to 3.0.0
|
|
138
159
|
|
|
@@ -200,13 +221,15 @@ use `!doctype table` instead, otherwise you'll get errors that modules are not a
|
|
|
200
221
|
|
|
201
222
|
Initial release.
|
|
202
223
|
|
|
203
|
-
[unreleased]: https://github.com/
|
|
204
|
-
[3.
|
|
205
|
-
[3.
|
|
206
|
-
[3.
|
|
207
|
-
[3.
|
|
208
|
-
[3.
|
|
209
|
-
[
|
|
210
|
-
[
|
|
211
|
-
[
|
|
212
|
-
[
|
|
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
|
|
234
|
+
[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
|
|
@@ -2,11 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Set up your environment
|
|
4
4
|
|
|
5
|
-
1.
|
|
6
|
-
|
|
7
|
-
```shell
|
|
8
|
-
git clone git@github.com:taminomara/sphinx-lua-ls.git
|
|
9
|
-
```
|
|
5
|
+
1. Clone the repository.
|
|
10
6
|
|
|
11
7
|
2. Create a virtual environment with python `3.12` or newer.
|
|
12
8
|
|
|
@@ -58,3 +54,20 @@ make html
|
|
|
58
54
|
```
|
|
59
55
|
|
|
60
56
|
Sphinx-LuaLs will download the latest version of Lua Language Server for you.
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
## Release
|
|
60
|
+
|
|
61
|
+
1. Update `changelog.md`. Make sure to update links at the end of the file.
|
|
62
|
+
|
|
63
|
+
Changelog *must* have a section for the new release, otherwise the build
|
|
64
|
+
will fail.
|
|
65
|
+
|
|
66
|
+
2. Push a git tag. You'll need a repository admin role to do so.
|
|
67
|
+
|
|
68
|
+
All tags should start with prefix `v`, and follow semantic versioning guidelines.
|
|
69
|
+
This, among other things, means that tags for beta-, post-, etc. releases
|
|
70
|
+
should have form `v1.0.0-beta0` instead of Python's `v1.0.0b0`.
|
|
71
|
+
|
|
72
|
+
3. From here, release happens automatically. PyPi package will be uploaded from
|
|
73
|
+
CI job, and documentation will be updated by Read the Docs build.
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: sphinx-lua-ls
|
|
3
|
-
Version: 3.
|
|
3
|
+
Version: 3.5.0.post1
|
|
4
4
|
Summary: Automatic documentation generation via EmmyLua/LuaLs
|
|
5
5
|
Author-email: Tamika Nomara <taminomara@gmail.com>
|
|
6
6
|
License-Expression: MIT
|
|
7
|
-
Project-URL: Documentation, https://
|
|
8
|
-
Project-URL: Issues, https://github.com/
|
|
9
|
-
Project-URL: Source, https://github.com/
|
|
10
|
-
Project-URL: Changelog, https://github.com/
|
|
7
|
+
Project-URL: Documentation, https://sphinx-lua-ls.readthedocs.io/en/stable/
|
|
8
|
+
Project-URL: Issues, https://github.com/sphinx-contrib/lua-ls/issues
|
|
9
|
+
Project-URL: Source, https://github.com/sphinx-contrib/lua-ls/
|
|
10
|
+
Project-URL: Changelog, https://github.com/sphinx-contrib/lua-ls/blob/main/CHANGELOG.md
|
|
11
11
|
Classifier: Development Status :: 5 - Production/Stable
|
|
12
12
|
Classifier: Programming Language :: Python :: 3 :: Only
|
|
13
13
|
Classifier: Programming Language :: Python :: 3
|
|
@@ -38,10 +38,10 @@ Document Lua projects using Lua Language Server's output. This plugin features:
|
|
|
38
38
|
|
|
39
39
|
## Resources
|
|
40
40
|
|
|
41
|
-
- [Documentation](https://
|
|
42
|
-
- [Installation](https://
|
|
43
|
-
- [Quickstart](https://
|
|
44
|
-
- [Example output](https://
|
|
41
|
+
- [Documentation](https://sphinx-lua-ls.readthedocs.io/en/stable/)
|
|
42
|
+
- [Installation](https://sphinx-lua-ls.readthedocs.io/en/stable/installation.html)
|
|
43
|
+
- [Quickstart](https://sphinx-lua-ls.readthedocs.io/en/stable/quickstart.html)
|
|
44
|
+
- [Example output](https://sphinx-lua-ls.readthedocs.io/en/stable/example.html)
|
|
45
45
|
|
|
46
46
|
## Requirements
|
|
47
47
|
|
|
@@ -7,10 +7,10 @@ Document Lua projects using Lua Language Server's output. This plugin features:
|
|
|
7
7
|
|
|
8
8
|
## Resources
|
|
9
9
|
|
|
10
|
-
- [Documentation](https://
|
|
11
|
-
- [Installation](https://
|
|
12
|
-
- [Quickstart](https://
|
|
13
|
-
- [Example output](https://
|
|
10
|
+
- [Documentation](https://sphinx-lua-ls.readthedocs.io/en/stable/)
|
|
11
|
+
- [Installation](https://sphinx-lua-ls.readthedocs.io/en/stable/installation.html)
|
|
12
|
+
- [Quickstart](https://sphinx-lua-ls.readthedocs.io/en/stable/quickstart.html)
|
|
13
|
+
- [Example output](https://sphinx-lua-ls.readthedocs.io/en/stable/example.html)
|
|
14
14
|
|
|
15
15
|
## Requirements
|
|
16
16
|
|
|
@@ -165,8 +165,8 @@ can be slightly different:
|
|
|
165
165
|
}
|
|
166
166
|
|
|
167
167
|
|
|
168
|
-
Autodoc
|
|
169
|
-
|
|
168
|
+
Autodoc directives
|
|
169
|
+
------------------
|
|
170
170
|
|
|
171
171
|
.. rst:directive:: .. lua:autoobject:: name
|
|
172
172
|
|
|
@@ -175,14 +175,14 @@ Autodoc directive
|
|
|
175
175
|
:rst:dir:`lua:autoobject` supports same settings as other lua directives,
|
|
176
176
|
as well as some additional ones:
|
|
177
177
|
|
|
178
|
-
.. rst:directive:option:: members
|
|
178
|
+
.. rst:directive:option:: members: [<name>, ...]
|
|
179
179
|
|
|
180
180
|
If enabled, autodoc will also document object's members. You can pass a list
|
|
181
181
|
of comma-separated names to specify which members should be documented.
|
|
182
182
|
Otherwise, this option will document all public non-special members
|
|
183
183
|
which have a description.
|
|
184
184
|
|
|
185
|
-
.. rst:directive:option:: undoc-members
|
|
185
|
+
.. rst:directive:option:: undoc-members: [<name>, ...]
|
|
186
186
|
|
|
187
187
|
Include undocumented members to the object's description. By default,
|
|
188
188
|
they are skipped even if :rst:dir:`members <lua:autoobject:members>` is passed.
|
|
@@ -190,16 +190,16 @@ Autodoc directive
|
|
|
190
190
|
Accepts a comma-separated list of names; if list is empty,
|
|
191
191
|
adds all undoc members.
|
|
192
192
|
|
|
193
|
-
.. rst:directive:option:: private-members
|
|
194
|
-
protected-members
|
|
195
|
-
package-members
|
|
193
|
+
.. rst:directive:option:: private-members: [<name>, ...]
|
|
194
|
+
protected-members: [<name>, ...]
|
|
195
|
+
package-members: [<name>, ...]
|
|
196
196
|
|
|
197
197
|
Include non-public members to the object's description.
|
|
198
198
|
|
|
199
199
|
Accepts a comma-separated list of names; if list is empty,
|
|
200
200
|
adds all non-public members.
|
|
201
201
|
|
|
202
|
-
.. rst:directive:option:: special-members
|
|
202
|
+
.. rst:directive:option:: special-members: [<name>, ...]
|
|
203
203
|
|
|
204
204
|
Include members whose names start with double underscore
|
|
205
205
|
to the object's description.
|
|
@@ -207,25 +207,25 @@ Autodoc directive
|
|
|
207
207
|
Accepts a comma-separated list of names; if list is empty,
|
|
208
208
|
adds all special members.
|
|
209
209
|
|
|
210
|
-
.. rst:directive:option:: inherited-members
|
|
210
|
+
.. rst:directive:option:: inherited-members: [<name>, ...]
|
|
211
211
|
|
|
212
212
|
For classes, include members inherited from base classes.
|
|
213
213
|
|
|
214
214
|
Accepts a comma-separated list of names; if list is empty,
|
|
215
215
|
adds all inherited members.
|
|
216
216
|
|
|
217
|
-
.. rst:directive:option:: exclude-members
|
|
217
|
+
.. rst:directive:option:: exclude-members: [<name>, ...]
|
|
218
218
|
|
|
219
219
|
A comma-separated list of members that should not be documented.
|
|
220
220
|
|
|
221
|
-
.. rst:directive:option:: globals
|
|
221
|
+
.. rst:directive:option:: globals: [<name>, ...]
|
|
222
222
|
|
|
223
223
|
Will include global variables declared in the corresponding module.
|
|
224
224
|
|
|
225
225
|
Accepts a comma-separated list of names; if list is empty,
|
|
226
226
|
adds all global variables.
|
|
227
227
|
|
|
228
|
-
.. rst:directive:option:: class-doc-from
|
|
228
|
+
.. rst:directive:option:: class-doc-from: class | ctor | both | separate
|
|
229
229
|
|
|
230
230
|
Specifies how to generate documentation for classes
|
|
231
231
|
if :py:data:`class_default_function_name` is configured.
|
|
@@ -242,7 +242,7 @@ Autodoc directive
|
|
|
242
242
|
- ``separate``: only use documentation from ``@class`` annotation,
|
|
243
243
|
document class constructor as a separate method.
|
|
244
244
|
|
|
245
|
-
.. rst:directive:option:: class-signature
|
|
245
|
+
.. rst:directive:option:: class-signature: bases | ctor | both | minimal
|
|
246
246
|
|
|
247
247
|
Specifies how to generate signatures for classes
|
|
248
248
|
if :py:data:`class_default_function_name` is configured.
|
|
@@ -302,7 +302,7 @@ Autodoc directive
|
|
|
302
302
|
(see :py:data:`lua_ls_default_options` for info on ``+``
|
|
303
303
|
and overriding defaults).
|
|
304
304
|
|
|
305
|
-
.. rst:directive:option:: member-order
|
|
305
|
+
.. rst:directive:option:: member-order: alphabetical | groupwise | bysource
|
|
306
306
|
|
|
307
307
|
Controls how members are sorted. There are three options available:
|
|
308
308
|
|
|
@@ -314,11 +314,11 @@ Autodoc directive
|
|
|
314
314
|
- ``bysource``: members are sorted in the same order as they appear in code.
|
|
315
315
|
This is the default option.
|
|
316
316
|
|
|
317
|
-
.. rst:directive:option:: module-member-order
|
|
317
|
+
.. rst:directive:option:: module-member-order: alphabetical | groupwise | bysource
|
|
318
318
|
|
|
319
319
|
Overrides :rst:dir:`lua:autoobject:member-order` for modules.
|
|
320
320
|
|
|
321
|
-
.. rst:directive:option:: title
|
|
321
|
+
.. rst:directive:option:: title: <text>
|
|
322
322
|
|
|
323
323
|
For modules, controls whether a title is inserted between module description
|
|
324
324
|
and documentation of its members.
|
|
@@ -327,7 +327,7 @@ Autodoc directive
|
|
|
327
327
|
|
|
328
328
|
Adds :rst:dir:`lua:autoindex` to the toplevel module.
|
|
329
329
|
|
|
330
|
-
.. rst:directive:option:: index-title
|
|
330
|
+
.. rst:directive:option:: index-title: <text>
|
|
331
331
|
|
|
332
332
|
Allows overriding title of the :rst:dir:`lua:autoindex` section.
|
|
333
333
|
|
|
@@ -335,7 +335,7 @@ Autodoc directive
|
|
|
335
335
|
|
|
336
336
|
Adds :rst:dir:`lua:other-inherited-members` to all classes.
|
|
337
337
|
|
|
338
|
-
.. rst:directive:option:: annotate-require
|
|
338
|
+
.. rst:directive:option:: annotate-require: always | never | auto | force
|
|
339
339
|
|
|
340
340
|
Adds information about how to require a module.
|
|
341
341
|
|
|
@@ -355,16 +355,51 @@ Autodoc directive
|
|
|
355
355
|
|
|
356
356
|
LuaLs only supports ``never`` and ``force``.
|
|
357
357
|
|
|
358
|
-
.. rst:directive:option:: require-function-name
|
|
358
|
+
.. rst:directive:option:: require-function-name: <name>
|
|
359
359
|
|
|
360
360
|
Allows overriding name of the `require` function
|
|
361
361
|
for :rst:dir:`lua:autoobject:annotate-require`.
|
|
362
362
|
|
|
363
|
-
.. rst:directive:option:: require-separator
|
|
363
|
+
.. rst:directive:option:: require-separator: <str>
|
|
364
364
|
|
|
365
365
|
Allows overriding separator
|
|
366
366
|
for :rst:dir:`lua:autoobject:annotate-require`.
|
|
367
367
|
|
|
368
|
+
.. rst:directive:: .. lua:auto*::
|
|
369
|
+
|
|
370
|
+
In addition to :rst:dir:`lua:autoobject`, there are ``lua:autodata``,
|
|
371
|
+
``lua:autoattribute``, ``lua:autoclass``, and other ``lua:auto*`` directives.
|
|
372
|
+
|
|
373
|
+
They work like ``lua:autoobject``, but apply their doctype to the documented object
|
|
374
|
+
(if ``!doctype`` was :ref:`set in source code <doc_comments>`,
|
|
375
|
+
it shouldn't conflict with the used directive).
|
|
376
|
+
|
|
377
|
+
They also allow overriding object's signature, which may be useful when
|
|
378
|
+
automatically generated signature is too long:
|
|
379
|
+
|
|
380
|
+
.. tab-set::
|
|
381
|
+
:sync-group: lang
|
|
382
|
+
|
|
383
|
+
.. tab-item:: RST
|
|
384
|
+
:sync: rst
|
|
385
|
+
|
|
386
|
+
.. code-block:: rst
|
|
387
|
+
|
|
388
|
+
.. lua:autofunction:: logging.getLogger(name: string?): logging.Logger
|
|
389
|
+
|
|
390
|
+
.. tab-item:: Markdown
|
|
391
|
+
:sync: md
|
|
392
|
+
|
|
393
|
+
.. code-block:: myst
|
|
394
|
+
|
|
395
|
+
```{lua:autofunction} logging.getLogger(name: string? = ...): logging.Logger
|
|
396
|
+
```
|
|
397
|
+
|
|
398
|
+
.. dropdown:: Example output
|
|
399
|
+
|
|
400
|
+
.. lua:autofunction:: logging.getLogger(name: string? = ...): logging.Logger
|
|
401
|
+
:no-index:
|
|
402
|
+
|
|
368
403
|
.. rst:directive:: .. lua:autoindex:: module-name
|
|
369
404
|
|
|
370
405
|
Creates a table that references all documented objects in the module ``module-name``.
|
|
@@ -387,6 +422,7 @@ Autodoc directive
|
|
|
387
422
|
If given, class name must be absolute, even if this directive appears after
|
|
388
423
|
:rst:dir:`lua:module`.
|
|
389
424
|
|
|
425
|
+
.. _doc_comments:
|
|
390
426
|
|
|
391
427
|
Controlling generation from code comments
|
|
392
428
|
-----------------------------------------
|
|
@@ -38,7 +38,7 @@ intersphinx_mapping = {
|
|
|
38
38
|
html_theme = "furo"
|
|
39
39
|
html_extra_path = ["_extra/robots.txt"]
|
|
40
40
|
html_theme_options = {
|
|
41
|
-
"source_repository": "https://github.com/
|
|
41
|
+
"source_repository": "https://github.com/sphinx-contrib/lua-ls",
|
|
42
42
|
"source_branch": "main",
|
|
43
43
|
"source_directory": "docs/source",
|
|
44
44
|
}
|
|
@@ -283,10 +283,13 @@ Parameters
|
|
|
283
283
|
All directives that document Lua objects accept the standard parameters:
|
|
284
284
|
|
|
285
285
|
.. rst:directive:option:: no-index
|
|
286
|
+
no-index-entry
|
|
287
|
+
no-contents-entry
|
|
288
|
+
no-typesetting
|
|
286
289
|
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
+
The `standard Sphinx options`__ available to all object descriptions.
|
|
291
|
+
|
|
292
|
+
__ https://www.sphinx-doc.org/en/master/usage/domains/index.html#basic-markup
|
|
290
293
|
|
|
291
294
|
.. rst:directive:option:: private
|
|
292
295
|
protected
|
|
@@ -329,7 +332,7 @@ All directives that document Lua objects accept the standard parameters:
|
|
|
329
332
|
|
|
330
333
|
Fetches content from the given url.
|
|
331
334
|
|
|
332
|
-
.. rst:directive:option:: annotation
|
|
335
|
+
.. rst:directive:option:: annotation: <text>
|
|
333
336
|
|
|
334
337
|
Allows adding custom short annotations.
|
|
335
338
|
|
|
@@ -384,12 +387,12 @@ All directives that document Lua objects accept the standard parameters:
|
|
|
384
387
|
|
|
385
388
|
Use ``name`` and ``surname`` instead.
|
|
386
389
|
|
|
387
|
-
.. rst:directive:option:: synopsis
|
|
390
|
+
.. rst:directive:option:: synopsis: <text>
|
|
388
391
|
|
|
389
392
|
Allows adding a small description that's reflected
|
|
390
393
|
in the :rst:dir:`lua:autoindex` output.
|
|
391
394
|
|
|
392
|
-
.. rst:directive:option:: module
|
|
395
|
+
.. rst:directive:option:: module: <name>
|
|
393
396
|
|
|
394
397
|
Allows overriding current module for a single object. This is useful
|
|
395
398
|
for documenting global variables that are declared in a module.
|
|
@@ -58,4 +58,10 @@ function logging.Logger:warning(msg, ...) end
|
|
|
58
58
|
--- @param ... any parameters for message formatting.
|
|
59
59
|
function logging.Logger:error(msg, ...) end
|
|
60
60
|
|
|
61
|
+
--- Get logger with the given name, or create one if it doesn't exist.
|
|
62
|
+
---
|
|
63
|
+
--- @param name string? logger name. Uses current module name if empty.
|
|
64
|
+
--- @return Logger logger logger with the given name.
|
|
65
|
+
function logging.getLogger(name) end
|
|
66
|
+
|
|
61
67
|
return logging
|
|
@@ -36,7 +36,21 @@ Settings
|
|
|
36
36
|
.. py:data:: lua_ls_min_version
|
|
37
37
|
:type: str
|
|
38
38
|
|
|
39
|
-
Controls the
|
|
39
|
+
Controls the minimum version of the used lua analyzer.
|
|
40
|
+
|
|
41
|
+
Analyzer version should be greater than or equal to this version.
|
|
42
|
+
|
|
43
|
+
For LuaLs, default value is ``3.0.0``, for EmmyLua it's ``0.11.0``.
|
|
44
|
+
|
|
45
|
+
.. py:data:: lua_ls_max_version
|
|
46
|
+
:type: str | None
|
|
47
|
+
|
|
48
|
+
Controls the maximum version of the used lua analyzer.
|
|
49
|
+
|
|
50
|
+
Analyzer version should be strictly less than this version.
|
|
51
|
+
|
|
52
|
+
For LuaLs, default value is ``4.0.0``, for EmmyLua it's ``2.0.0``.
|
|
53
|
+
Use ``None`` to allow any version.
|
|
40
54
|
|
|
41
55
|
.. py:data:: lua_ls_default_options
|
|
42
56
|
:type: dict[str, str]
|
|
@@ -44,7 +44,7 @@ test = [
|
|
|
44
44
|
"pytest==8.4.2",
|
|
45
45
|
"sybil==9.2.0",
|
|
46
46
|
"pytest-regressions==2.8.3",
|
|
47
|
-
"beautifulsoup4==4.14.
|
|
47
|
+
"beautifulsoup4==4.14.2",
|
|
48
48
|
"myst-parser==4.0.1"
|
|
49
49
|
]
|
|
50
50
|
doc = [
|
|
@@ -55,10 +55,10 @@ doc = [
|
|
|
55
55
|
]
|
|
56
56
|
|
|
57
57
|
[project.urls]
|
|
58
|
-
Documentation = "https://
|
|
59
|
-
Issues = "https://github.com/
|
|
60
|
-
Source = "https://github.com/
|
|
61
|
-
Changelog = "https://github.com/
|
|
58
|
+
Documentation = "https://sphinx-lua-ls.readthedocs.io/en/stable/"
|
|
59
|
+
Issues = "https://github.com/sphinx-contrib/lua-ls/issues"
|
|
60
|
+
Source = "https://github.com/sphinx-contrib/lua-ls/"
|
|
61
|
+
Changelog = "https://github.com/sphinx-contrib/lua-ls/blob/main/CHANGELOG.md"
|
|
62
62
|
|
|
63
63
|
[build-system]
|
|
64
64
|
requires = ["setuptools>=60", "setuptools_scm[toml]>=8", "wheel>=0.40"]
|