Migrate To docgen.nvim

[alex-courtis]

https://github.com/jamestrew/docgen.nvim is a documentation generator that is quite similar to Nvim's, using the same luacats internals. It's written by the telescope author and is under active development / use.

It generates documentation that is nearly the same, with a few QOL fixes such as automatic links to classes/functions.

This is desirable as Nvim's is not public API and has changed a few times e.g. #3314

[alex-courtis]

POC looks good.

Only changes are formatting, some links added and order is determined by the file, not alpha.

It will need a bit of tweaking and maybe an upstream PR to get all the functions / methods named correctly.

Has @eval which we can use to execute lua to generate keymap etc.

.deps/docgen.nvim:
	git clone --depth 1 --branch v1.1.0 https://github.com/jamestrew/docgen.nvim $@

docgen: .deps/docgen.nvim
	nvim -l scripts/gendocs.lua

vim.opt.rtp:prepend("../plenary.nvim")
vim.opt.rtp:prepend(".")
vim.opt.rtp:prepend(".deps/docgen.nvim")

local base = "./lua/nvim-tree/"

require("docgen").run({
  name = "nvim-tree-lua",
  description = "A File Explorer For Nvim",
  files = {
    base .. "_meta/config.lua",

    {
      base .. "_meta/config/sort.lua",
      title = "Config: sort",
      tag = "nvim-tree-config-sort",
    },
    base .. "_meta/config/view.lua",
    base .. "_meta/config/renderer.lua",
    base .. "_meta/config/hijack_directories.lua",
    base .. "_meta/config/update_focused_file.lua",
    base .. "_meta/config/git.lua",
    base .. "_meta/config/diagnostics.lua",
    base .. "_meta/config/modified.lua",
    base .. "_meta/config/filters.lua",
    base .. "_meta/config/live_filter.lua",
    base .. "_meta/config/filesystem_watchers.lua",
    base .. "_meta/config/actions.lua",
    base .. "_meta/config/trash.lua",
    base .. "_meta/config/tab.lua",
    base .. "_meta/config/notify.lua",
    base .. "_meta/config/bookmarks.lua",
    base .. "_meta/config/help.lua",
    base .. "_meta/config/ui.lua",
    base .. "_meta/config/experimental.lua",
    base .. "_meta/config/log.lua",

    base .. "_meta/config/default.lua",

    base .. "api.lua",
    base .. "_meta/api/appearance.lua",
    base .. "_meta/api/commands.lua",
    {
      base .. "_meta/api/config.lua",
      title = "API: config",
      tag = "nvim-tree-api-config",
      fn_prefix = "",
      fn_tag_prefix = "",
    },
    base .. "_meta/api/events.lua",
    base .. "_meta/api/filter.lua",
    base .. "_meta/api/fs.lua",
    base .. "_meta/api/git.lua",
    base .. "_meta/api/map.lua",
    base .. "_meta/api/marks.lua",
    base .. "_meta/api/node.lua",
    base .. "_meta/api/tree.lua",
    base .. "classic.lua",
    {
      base .. "_meta/api/decorator.lua",
      title = "Class: Decorator",
      tag = "nvim-tree-class-decorator",
    },
    base .. "_meta/api/decorator_example.lua",
  },
})