Gathering feedback on `sphinx-benchmark` extension + Proposal to add the `sphinx-benchmark` extension to the sphinx-doc github organisation

[Aditi Juneja]

Hi Sphinx maintainers/users/contributors,

I've been building a tool that benchmarks and profiles Sphinx's documentation builds. It breaks down a build and times event by event, then handler by handler within each event, and it also reports a summary for the time between event emissions.

sphinx-benchmark extension link: https://github.com/Schefflera-Arboricola/sphinx-benchmark
PyPI: https://pypi.org/project/sphinx-benchmark/

I'd love for Sphinx users, maintainers, contributors, extension developers and everyone to try it out and share your feedback/questions/issues -- what's wrong with it or missing. Another release is coming shortly with more improvements.

Also, I've been building this as part of the Quansight internship this year, and I was wondering whether the Sphinx community would be open to hosting it in the org. I think being under the Sphinx umbrella would help the project get more visibility, usage and community engagement. I would really like to keep maintaining it after the internship as well, and I would be happy to change the project if needed to meet the project's standards for code, docs, testing, or release process, etc. Please LMK if you have any questions or concerns-- I would be happy to address those.

If there's a more appropriate place to post this, please point me there and I'll move it. Also posted this on GitHub discussions: https://github.com/orgs/sphinx-doc/discussions/14652

Thank you for your time!


Fun Fact: Recently a SunPy maintainer ran this extension with their docs and was able to reduce the docs build time from 317s to 190s -- roughly 40% off their docs build. They tracked it down to an empty-template render check running the main nav twice per page, and fixed it with a config option (refer https://github.com/pydata/pydata-sphinx-theme/pull/2477 and https://github.com/sunpy/sunpy-sphinx-theme/pull/332). Projects using the same sunpy-sphinx-theme (like astropy) may also see a similar speedup soon.

[Blaise Pabon]

Thank you, I will look into this!!

[Kayce Basques]

Looks great! Just left a comment in the GitHub discussion: https://github.com/orgs/sphinx-doc/discussions/14652#discussioncomment-18472686

--
You received this message because you are subscribed to the Google Groups "sphinx-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-dev+...@googlegroups.com.
To view this discussion, visit https://groups.google.com/d/msgid/sphinx-dev/54de4334-2b51-4b46-8277-790e238ae29fn%40googlegroups.com.