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 request - regenerate docs only for modified files #28

Open
nathanl opened this issue Oct 20, 2010 · 1 comment
Open

Feature request - regenerate docs only for modified files #28

nathanl opened this issue Oct 20, 2010 · 1 comment

Comments

@nathanl
Copy link

nathanl commented Oct 20, 2010

We are now running PHPDoctor as a nightly cron job on our code base. Since it's large, this takes several hours.

One neat feature would be the ability to say "only regenerate documentation for files that git shows as changed."

I realize this would be complicated - you'd have to store a record of parent-child class relationships on disk, I imagine - but I thought I'd mention the idea.

@peej
Copy link
Owner

peej commented Oct 21, 2010

That's a pretty massive codebase if it takes several hours, it's cool to hear that you're using it on such a big project and it's working for you.

The best way to implement this from my initial thoughts would be to somehow cache the processed doc objects and then overwrite any created by files that have been modified. And finally to regenerate all the documentation via the doclet.

It might also help with your memory problem if the solution requires creating an intermediate doc object format to be written to disk.

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

No branches or pull requests

2 participants