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.

i didn't find any command to do that i tried powershell script to read alla files but doesn't work in LDoc case because it overwrite same always — Antwan, Jul 18 '14 at 02:38
the output is the default path myluainstallationpath/doc/index.html — Antwan, Jul 18 '14 at 09:07
Please add your config file to your post (*not* in a comment) — Oliver, Jul 18 '14 at 17:55
thx schollii but i want to know is there any way to generate doc for whole project in ldoc like an attribute or something i have read all the documentation and i didnt find any thing talking about that — Antwan, Jul 18 '14 at 19:46

Oliver · Accepted Answer · 2014-07-19T14:23:16.137

2

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..

edited Jul 19 '14 at 14:23

answered Jul 19 '14 at 01:08

Oliver

27,510
9
72
103

Hm, I try something similar but ldoc does not generate anything if I pass the root directory ([see](https://github.com/stevedonovan/LDoc/issues/258)). Any idea what I might do wrong? – Stefan Falk Dec 18 '16 at 11:04

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

1 Answers1