Documenter.jl: Debugging: Print current page being processed.

[Datseris]

For debugging purposes, there could be a way to enable Documenter to output which page is currently being processed.

For example, during doc build for a package of mine one page takes a _lot_ of time and I am trying to identify which code is the one to blame.

Fredrik also commented that his could done by adding some @debug statements.

[mortenpi]

@debugs for this would be great. What would be the recommended way of enabling them? JULIA_DEBUG=Documenter?

[Datseris]

At the moment it is not possible to build a documentation with Documenter hat requires code running for more than 10 minutes. Solving this would also solve the problem.

I don't know how to solve this issue.

[mortenpi]

At the moment it is not possible to build a documentation with Documenter hat requires code running for more than 10 minutes.

Some sort of a ProgressMeter-style async task printing something out every 30s or so for long-running at-blocks might be a more reliable solution here perhaps?

[Datseris]

Some sort of a ProgressMeter-style async task printing something out every 30s or so for long-running at-blocks might be a more reliable solution here perhaps?

I don't know how to do this unfortunately.

[mortenpi]

@Datseris FYI, #1029 added an @debug that prints the page name being processed. So if you switch to Documenter to master and set JULIA_DEBUG=Documenter, it might work around your specific case.

I would leave the issue open though -- I think an async approach would be preferred as a proper fix (e.g. if you have a single page that takes more than 10min to process).

[Datseris]

Thanks I'll try this next time I need it, but I agree with keeping the issue open, exactly for the reason you mentioned.

EDIT: Sorry for not replying here, this worked amazingly for us.

[jpfairbanks]

I just used this issue to find this ENV flag, could it be added to the package docs?

[mortenpi]

I just used this issue to find this ENV flag, could it be added to the package docs?

Happy to take a PR :slightly_smiling_face: