use LDoc to generate document for whole lua project with index page

Question

I want to generate documentation for my lua project but with Ldoc i generate docs for each single lua file and the output file every time overwrite the index.html file .

So my question is how i can generate generate documentation for the whole project with index page that has link to the all pages.

I tried to do that with see tag but i don't know if i can use it to reference to another file not another part in the document

I used this:

ldoc.lua.bat pathtomyproject/filename.lua

The output is the default path myluainstallationpath/doc/index.html.

Answer 1

Try ldoc.lua.bat pathtomyproject instead. This will generate the docs for all the files in pathtomyproject and will generate an index.html that links to each file used in that folder..