Skip to content

Commit 4a103c7

Browse files
committed
Fix sphinx-lua-ls config and annotations
1 parent abc38bf commit 4a103c7

File tree

5 files changed

+12
-7
lines changed

5 files changed

+12
-7
lines changed

docs/conf.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@
2828

2929
lua_ls_project_root = ".."
3030
lua_ls_backend = "luals"
31-
lua_ls_project_directories = [
32-
".."
33-
]
31+
lua_ls_apidoc_default_options = {
32+
"undoc-members": "",
33+
"protected-members": "",
34+
"globals": "",
35+
}
3436
lua_ls_apidoc_roots = {
3537
"unicorn": "api",
3638
}

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,5 @@ documentation for details.
1414
.. toctree::
1515
:maxdepth: 2
1616
:caption: Contents:
17+
1718
api/index.rst

unicorn/core.lua

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
--- A modular package manager.
22

33
package.path = "/lib/?.lua;/lib/?;/lib/?/init.lua;" .. package.path
4-
--- !doctype module
5-
----@class lib.module
64
local unicorn = {}
75
--- !doctype module
8-
----@class lib.module
6+
--- @class unicorn.core
97
unicorn.core = {}
108
unicorn.util = require("unicorn.util")
119
local semver = require("semver")

unicorn/init.lua

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
--- @namespace unicorn
21
package.path = "/lib/?.lua;/lib/?;/lib/?/init.lua;" .. package.path
2+
3+
--- !doctype module
4+
--- @class unicorn
35
local unicorn = {}
46
unicorn.core = require("unicorn.core")
57
unicorn.util = require("unicorn.util")

unicorn/util.lua

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
--- Utility functions for use with unicornpkg.
22

33
local unicorn = {}
4+
--- !doctype module
5+
--- @class unicorn.core
46
unicorn.util = {}
57

68
local http = http

0 commit comments

Comments
 (0)