How to use the --doc flag to generate documentation?

[linrongbin16]

Hi, I have a project https://github.com/linrongbin16/commons.nvim, and I use below command (macOS, installed via homebrew) to generate the doc:

lua-language-server --doc ./lua/commons/numbers.lua

here's the output:

The generated doc.md (in /opt/homebrew/Cellar/lua-language-server/3.7.3/libexec/log/doc.md) looks like:

But there's no API document for those functions in numbers.lua.

[carsakiller]

I believe the --doc option expects its value to be the output path, so it may be confused here and just generating the default globals. I think it generates documentation based off of the current working directory.

[linrongbin16]

hi @carsakiller , do you mean use this?

seems the doc.md still generated in /opt/homebrew/Cellar/lua-language-server/3.7.3/libexec/log/doc.md

[carsakiller]

Hmm, judging by the changelog, I think you are correct. It always outputs to the logpath and you provide the target workspace as an argument. Looks like the wiki could use some clarifying.

Perhaps this should be converted to an issue instead, then.

[rhys-vdw]

I don't understand how you're getting any output at all. #2954