c0b2834652
* chore: add @dochide annotation - it's easier to distinguish @private and something i dont want to see in docs * docs: update * refactor: move thing out to utils * fix: lua-ls error * fixup! refactor: move thing out to utils * docs: update
37 lines
907 B
Lua
37 lines
907 B
Lua
---@diagnostic disable: undefined-global
|
|
--# selene: allow(undefined_variable)
|
|
|
|
local okay, minidoc = pcall(require, "mini.doc")
|
|
if not okay then
|
|
error "mini.doc not found, please install it. https://github.com/echasnovski/mini.doc"
|
|
return
|
|
end
|
|
|
|
local files = {
|
|
"lua/gopher/init.lua",
|
|
"lua/gopher/config.lua",
|
|
"plugin/gopher.lua",
|
|
"lua/gopher/struct_tags.lua",
|
|
"lua/gopher/impl.lua",
|
|
"lua/gopher/gotests.lua",
|
|
"lua/gopher/iferr.lua",
|
|
"lua/gopher/comment.lua",
|
|
}
|
|
|
|
minidoc.setup()
|
|
|
|
local hooks = vim.deepcopy(minidoc.default_hooks)
|
|
hooks.write_pre = function(lines)
|
|
-- Remove first two lines with `======` and `------` delimiters to comply
|
|
-- with `:h local-additions` template
|
|
table.remove(lines, 1)
|
|
table.remove(lines, 1)
|
|
|
|
return lines
|
|
end
|
|
|
|
hooks.sections["@dochide"] = function(s)
|
|
s.parent:clear_lines()
|
|
end
|
|
|
|
MiniDoc.generate(files, "doc/gopher.nvim.txt", { hooks = hooks })
|