Use confdir instead of srcdir as a base path

Author: taminomara

CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## [unreleased]
 
+- **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

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,