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

Profiling docs build times #2523

Open
jpfairbanks opened this issue Jun 7, 2024 · 3 comments
Open

Profiling docs build times #2523

jpfairbanks opened this issue Jun 7, 2024 · 3 comments

Comments

@jpfairbanks
Copy link
Contributor

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.

@mortenpi
Copy link
Member

mortenpi commented Jun 7, 2024

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

@jpfairbanks
Copy link
Contributor Author

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

@jpfairbanks
Copy link
Contributor Author

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.

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