Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Run ldoc on a single target file with same behavior as targeting a directory #408

Open
sparr opened this issue Sep 9, 2024 · 3 comments

Comments

@sparr
Copy link

sparr commented Sep 9, 2024

I would like to be able to ldoc -c ./config.ld path/file.lua and get the exact same docs/modules/file.html that I would get if I ran ldoc .. This might involve multiple new options to change behaviors around file naming and references.

@alerque
Copy link
Member

alerque commented Sep 9, 2024

Contributions welcome ;-) This would pair nicely with something like entr to rebuild docs quickly and preview the results while editing.

@sparr
Copy link
Author

sparr commented Sep 10, 2024

It's not clear to me why simply targeting a file produces such wildly different results than the file being included when targeting a directory currently. Is there any documentation, or even a particular part of the source, I should be looking at to better understand that?

@alerque
Copy link
Member

alerque commented Sep 10, 2024

I don't know (I'm an outsider that inherited a maintenance role on this project not the author so I'm just poking around like you) but I would guess it has to do with how the menus and such are generated. In fact it's probably not possible to get the same output without processing a whole project since what things to cross link and what things to put in menus wouldn't be known at all if not processing the whole project. That doesn't mean a mode couldn't be scrapped together to only update one output file even if the whole project still had to be scanned.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants