sphinx-lua-ls 3.3.0__tar.gz → 3.4.0__tar.gz

{sphinx_lua_ls-3.3.0 → sphinx_lua_ls-3.4.0}/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 ## [unreleased]
 
+## [3.4.0]
+
+- **Potential breaking change:** use `confdir` instead of `srcdir` as base path
+  for `lua_ls_project_root`.
+
+  Prior to this change, `lua_ls_project_root` was resolved relative to the directory
+  containing source `.rst` files. Documentation, however, was saying that it's resolved
+  relative to the directory with `conf.py`.
+
+  This is not an issue, because in most projects `conf.py` and source `.rst` files
+  are located in the same directory. Still, I've decided to be consistent with
+  other Sphinx extensions and use `confdir` instead of `srcdir`.
+
+  This is a breaking change, but I don't believe there are any projects that
+  use separate `confdir` and `srcdir` (the only reason to do this is if you're
+  hosting multiple documentation sites in the same repo.) For this reason,
+  this change is released as a minor version change.
+
 ## [3.3.0]
 
 - Added an option to extend list options (like `:exclude-members:`) without overriding
@@ -182,7 +200,8 @@ use `!doctype table` instead, otherwise you'll get errors that modules are not a
 
 Initial release.
 
-[unreleased]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.3.0...HEAD
+[unreleased]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.4.0...HEAD
+[3.4.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.3.0...v3.4.0
 [3.3.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.2.0...v3.3.0
 [3.2.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.1.0...v3.2.0
 [3.1.0]: https://github.com/taminomara/sphinx-lua-ls/compare/v3.0.0...v3.1.0

{sphinx_lua_ls-3.3.0/sphinx_lua_ls.egg-info → sphinx_lua_ls-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.3.0
+Version: 3.4.0
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License-Expression: MIT

{sphinx_lua_ls-3.3.0 → sphinx_lua_ls-3.4.0}/docs/source/autodoc.rst

@@ -16,10 +16,10 @@ can be slightly different:
       comments.
 
       When generating documentation for a module, Sphinx-LuaLs will include
-      all module's objects returned by `require`, as well as all types located
+      all module's objects returned by ``require``, as well as all types located
       in the same namespace.
 
-      That is, for module `meow`, it will list everything in the ``require("meow")``,
+      That is, for module ``meow``, it will list everything in the ``require("meow")``,
       as well as all classes, aliases, and enums that have prefix ``meow.*``.
 
       Thus, a typical Lua module will look like this:
@@ -185,7 +185,7 @@ Autodoc directive
    .. rst:directive:option:: undoc-members
 
       Include undocumented members to the object's description. By default,
-      they are skipped even if :rst:dir:`members` is passed.
+      they are skipped even if :rst:dir:`members <lua:autoobject:members>` is passed.
 
       Accepts a comma-separated list of names; if list is empty,
       adds all undoc members.

{sphinx_lua_ls-3.3.0 → sphinx_lua_ls-3.4.0}/docs/source/conf.py

@@ -12,6 +12,7 @@ release = version = sphinx_lua_ls.__version__
 
 extensions = [
     "sphinx.ext.githubpages",
+    "sphinx.ext.intersphinx",
     "sphinx_design",
     "sphinx_lua_ls",
     "myst_parser",
@@ -23,9 +24,14 @@ exclude_patterns = []
 primary_domain = "lua"
 default_role = "lua:obj"
 
-lua_ls_project_root = "../example"
+lua_ls_project_root = "example"
 lua_ls_backend = "emmylua"
 
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "sphinx": ("https://www.sphinx-doc.org/", None),
+}
+
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

{sphinx_lua_ls-3.3.0 → sphinx_lua_ls-3.4.0}/docs/source/settings.rst

@@ -89,14 +89,14 @@ Settings
 .. py:data:: class_default_force_non_colon
    :type:
 
-   If `true`, Sphinx-LuaLs will remove ``self`` from class constructor's signature.
+   If ``True``, Sphinx-LuaLs will remove ``self`` from class constructor's signature.
 
    If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
 
 .. py:data:: class_default_force_return_self
    :type:
 
-   If `true`, Sphinx-LuaLs will replace class constructor's return type with ``self``.
+   If ``True``, Sphinx-LuaLs will replace class constructor's return type with ``self``.
 
    If using EmmyLua as lua analyzer, this option will be inferred from ``.emmyrc.json``.
 
@@ -109,7 +109,7 @@ Settings
    Can be either ``"5.1"``, ``"5.2"``, ``"5.3"``, ``"5.4"``, or ``"jit"``.
 
    By default, Sphinx-LuaLs will choose this setting
-   based on your `.emmyrc.json`/`.luarc.json` file.
+   based on your ``.emmyrc.json``/``.luarc.json`` file.
 
 .. py:data:: lua_ls_apidoc_roots
    :type: dict[str, str | dict[str, Any]]
@@ -165,7 +165,7 @@ Settings
       This option might not work correctly on case-insensitive file systems.
 
       It will generate a separate file for every member of a module;
-      if there are members that only differ in case (i.e. `Class` vs `class`),
+      if there are members that only differ in case (i.e. ``Class`` vs ``class``),
       one of them will overwrite the file for another.
 
       If you're on Windows, and you experience difficulties because of it,
@@ -215,7 +215,7 @@ Settings
 
    Default value is ``50``, which is suitable for most Sphinx themes.
 
-   Setting this value to `None` will cause signature formatter
+   Setting this value to ``None`` will cause signature formatter
    to use Sphinx's global setting ``maximum_signature_line_length``.
    If ``maximum_signature_line_length`` is also ``None``,
    signature wrapping will be disabled.

{sphinx_lua_ls-3.3.0 → sphinx_lua_ls-3.4.0}/sphinx_lua_ls/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.3.0'
-__version_tuple__ = version_tuple = (3, 3, 0)
+__version__ = version = '3.4.0'
+__version_tuple__ = version_tuple = (3, 4, 0)
 
-__commit_id__ = commit_id = 'g1682461d4'
+__commit_id__ = commit_id = 'g02703ee01'

{sphinx_lua_ls-3.3.0 → sphinx_lua_ls-3.4.0}/sphinx_lua_ls/config.py

@@ -172,7 +172,7 @@ def set_options(app: sphinx.application.Sphinx):
     config = app.config
 
     project_root = _path(
-        "lua_ls_project_root", config["lua_ls_project_root"] or "", app.srcdir
+        "lua_ls_project_root", config["lua_ls_project_root"] or "", app.confdir
     )
 
     domain_config = LuaDomainConfig(project_root=project_root)
@@ -260,7 +260,7 @@ def set_options(app: sphinx.application.Sphinx):
     domain_config.apidoc_roots = _api_roots(
         "lua_ls_apidoc_roots",
         config["lua_ls_apidoc_roots"],
-        app.srcdir,
+        app.confdir,
         domain_config.apidoc_max_depth,
         domain_config.apidoc_default_options,
         domain_config.apidoc_ignored_modules,

{sphinx_lua_ls-3.3.0 → sphinx_lua_ls-3.4.0/sphinx_lua_ls.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sphinx-lua-ls
-Version: 3.3.0
+Version: 3.4.0
 Summary: Automatic documentation generation via EmmyLua/LuaLs
 Author-email: Tamika Nomara <taminomara@gmail.com>
 License-Expression: MIT