Documenter.jl icon indicating copy to clipboard operation
Documenter.jl copied to clipboard

Profiling docs build times

Open jpfairbanks opened this issue 1 year ago • 3 comments

Is there a way to get out the time to build each page? Either grepping the output for lines like INFO: Build Time ... that had the time to build each page, or a table that prints at the end of the build with all the build times would fine

My packages often have docs that use SciML solvers to run the examples and bad settings for the solver can lead to huge run times where I know that >90% of the time to build the docs is running the examples, but I don't know which pages are holding up the build unless I am watching the logs.

Base testing produces a little table for tests that would be a good design to copy.

jpfairbanks avatar Jun 07 '24 01:06 jpfairbanks

Good timing. Maybe you can be the guinea pig for #2521 and see how well that PR works for your use case :slightly_smiling_face:

mortenpi avatar Jun 07 '24 01:06 mortenpi

This would be perfect, the block-level profiling is what I really wanted.

jpfairbanks avatar Jun 07 '24 01:06 jpfairbanks

Looks like this will meet our needs, an option to roll up the times by page instead of block would be a nice-to-have, but not critical to the utility.

jpfairbanks avatar Jun 08 '24 02:06 jpfairbanks