Repository navigation
Add Sphinx extension for measuring durations in doc builds - #2268
Conversation
|
Thank you for submitting a pull request (PR) to PlasmaPy! ✨ The future of the project depends on contributors like you, so we deeply appreciate it! 🌱 Our contributor guide has information on:
The bottom of this page shows several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. 😺 Click on "Details" to learn why a check didn't pass. Please also feel free to ask for help. We do that all the time as well. 🌸 You can find us in our chat room or weekly community meeting & office hours. Here are some tips:
If this PR is marked as ready for review, someone should stop by to provide a code review and offer suggestions soon. ✅ If you don't get a review within a few days, please feel free to send us a reminder. Please also use SI units within PlasmaPy, except when there is strong justification otherwise or in some examples. We thank you once again! |
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #2268 +/- ##
=======================================
Coverage 98.37% 98.37%
=======================================
Files 98 98
Lines 8533 8533
=======================================
Hits 8394 8394
Misses 139 139 ☔ View full report in Codecov by Sentry. |
|
Merging this since it's a minimal change, and I plan to use it for another PR too. |
This PR adds
sphinx.ext.durationas a Sphinx extension to provide output on the durations for creating documentation. It could help us figure out where the performance bottlenecks are.I'm not sure if it'll be helpful to add this, or just use it when figuring out how to improve performance of doc builds.