PyPI - sphinx-lua-ls - Versions diffs - 2.0.0__tar.gz → 2.0.1__tar.gz - Mend

@@ -12,10 +12,8 @@ from typing import Any, Callable, ClassVar, Type
 import docutils.nodes
 import docutils.statemachine
-import docutils.transforms
 import sphinx.addnodes
-import sphinx.util.docutils
-import sphinx.util.nodes
+import sphinx.util
 from docutils.parsers.rst import directives
 from sphinx.util.docutils import SphinxDirective
 from sphinx.util.parsing import nested_parse_to_nodes
@@ -442,7 +440,7 @@ class AutodocDirectiveMixin(AutodocUtilsMixin):
             content_node += nodes
-class AutodocObjectMixin(sphinx_lua_ls.domain.LuaObject[Any], AutodocDirectiveMixin):
+class AutodocObjectMixin(AutodocDirectiveMixin, sphinx_lua_ls.domain.LuaObject[Any]):
     def transform_content(self, content_node: sphinx.addnodes.desc_content) -> None:
         fullname = self.names[-1][0] if self.names else None
         self.render_root_docstring(content_node, fullname)
@@ -453,7 +451,7 @@ class AutodocObjectMixin(sphinx_lua_ls.domain.LuaObject[Any], AutodocDirectiveMi
                 content_node += self.render(child, name)
-class LuaFunction(sphinx_lua_ls.domain.LuaFunction, AutodocObjectMixin):
+class LuaFunction(AutodocObjectMixin, sphinx_lua_ls.domain.LuaFunction):
     def parse_signature(self, sig):
         assert isinstance(self.root, sphinx_lua_ls.objtree.Function)
         return (
@@ -545,7 +543,7 @@ class LuaFunction(sphinx_lua_ls.domain.LuaFunction, AutodocObjectMixin):
                 )
-class LuaData(sphinx_lua_ls.domain.LuaData, AutodocObjectMixin):
+class LuaData(AutodocObjectMixin, sphinx_lua_ls.domain.LuaData):
     def parse_signature(self, sig):
         return (
             self.arguments[0],
@@ -553,12 +551,12 @@ class LuaData(sphinx_lua_ls.domain.LuaData, AutodocObjectMixin):
         )
-class LuaTable(sphinx_lua_ls.domain.LuaTable, AutodocObjectMixin):
+class LuaTable(AutodocObjectMixin, sphinx_lua_ls.domain.LuaTable):
     def parse_signature(self, sig):
         return (self.arguments[0], None)
-class LuaAlias(sphinx_lua_ls.domain.LuaAlias, AutodocObjectMixin):
+class LuaAlias(AutodocObjectMixin, sphinx_lua_ls.domain.LuaAlias):
     def parse_signature(self, sig):
         assert isinstance(self.root, sphinx_lua_ls.objtree.Alias)
         if _FIX_FLAKY_ALIAS_TESTS:
@@ -566,13 +564,15 @@ class LuaAlias(sphinx_lua_ls.domain.LuaAlias, AutodocObjectMixin):
         return self.arguments[0], self.root.type
-class LuaClass(sphinx_lua_ls.domain.LuaClass, AutodocObjectMixin):
+class LuaClass(AutodocObjectMixin, sphinx_lua_ls.domain.LuaClass):
     def parse_signature(self, sig):
         assert isinstance(self.root, sphinx_lua_ls.objtree.Class)
         return self.arguments[0], self.root.bases
-class LuaModule(sphinx_lua_ls.domain.LuaModule, AutodocDirectiveMixin):
+class LuaModule(AutodocDirectiveMixin, sphinx_lua_ls.domain.LuaModule):
+    option_spec: ClassVar[dict[str, Callable[[str], Any]]]
     def run(self) -> list[docutils.nodes.Node]:
         nodes = super().run()

@@ -1,5 +1,9 @@
 # Changelog
+## v2.0.1
+- Fixed documentation not being rebuilt after changing lua source code.
 ## v2.0.0
 - Breaking change: don't implicitly convert classes that're derived from `table`

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 2.0.0
+Version: 2.0.1
 Summary: Automatic documentation generation via LuaLS
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License: MIT License
@@ -66,6 +66,7 @@ Provides-Extra: doc
 Requires-Dist: sybil~=6.1; extra == "doc"
 Requires-Dist: furo>=2024; extra == "doc"
 Requires-Dist: sphinx_design>=0.6; extra == "doc"
+Dynamic: license-file
 # Sphinx plugin for Lua and Lua Language Server

@@ -3,12 +3,8 @@ import pathlib
 import re
 from typing import Any, Type, TypeVar
-import sphinx.addnodes
 import sphinx.application
-import sphinx.config
-import sphinx.environment
 import sphinx.errors
-import sphinx.ext.intersphinx
 from sphinx.errors import ConfigError
 from sphinx.util.display import progress_message
 from sphinx.util.fileutil import copy_asset_file

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
-__version__ = version = '2.0.0'
-__version_tuple__ = version_tuple = (2, 0, 0)
+__version__ = version = '2.0.1'
+__version_tuple__ = version_tuple = (2, 0, 1)

@@ -2,11 +2,9 @@ from collections import defaultdict
 import docutils.nodes
 import sphinx.addnodes
-import sphinx.environment
 from sphinx.transforms import SphinxTransform
 from sphinx.util.docutils import SphinxDirective
-import sphinx_lua_ls.autodoc
 import sphinx_lua_ls.domain
 from sphinx_lua_ls.objtree import Kind
@@ -54,6 +52,7 @@ class AutoIndexTransform(SphinxTransform):
             for fullname, (docname, objtype, _, synopsis) in self.env.domaindata["lua"][
                 "objects"
             ].items():
+                objtype: str
                 if not fullname.startswith(prefix):
                     continue
                 name = fullname[len(prefix) :]

@@ -438,8 +438,8 @@ class LuaObject(
     ) -> tuple[str, str, str, str, T]:
         name, sigdata = self.parse_signature(sig)
-        modname = self.options.get("module", self.env.ref_context.get("lua:module"))
-        classname = self.env.ref_context.get("lua:class", None)
+        modname = self.options.get("module", self.env.ref_context.get("lua:module", ""))
+        classname = self.env.ref_context.get("lua:class", "")
         fullname = ".".join(filter(None, [modname, classname, name]))
         if classname and "module" in self.options:

sphinx-lua-ls 2.0.0__tar.gz → 2.0.1__tar.gz

sphinx-lua-ls 2.0.0tar.gz → 2.0.1tar.gz