Everyone needs help, so lemmy-help you
lemmy-help is a emmylua parser as well as a CLI which takes that parsed tree and converts it into vim help docs.
cargobash
cargo install lemmy-help --features=cli
Check out the release page for prebuild binaries available for different operating systems.
To properly generate docs you should follow emmylua spec. The parser is capable of parsing most (not all) of the emmylua syntax. You can read the following doc which can give you the idea on how to properly write emmylua comments.
Using the CLI is simple just give it the path to the lua files; it will parse them and prints the help doc to stdout
NOTE: The order of parsing + rendering is same as in which they are defined
bash
lemmy-help \
"/path/to/first/file" \
"/path/to/second/file" \
"/path/to/third/file" > doc.txt