Skip to content

Add Sphinx extension for measuring durations in doc builds - #2268

Merged
namurphy merged 5 commits into
PlasmaPy:mainfrom
namurphy:sphinx-ext-duration
Aug 4, 2023
Merged

namurphy merged 5 commits into
PlasmaPy:mainfrom
namurphy:sphinx-ext-duration

Conversation

@namurphy

@namurphy namurphy commented Aug 3, 2023

Copy link
Copy Markdown
Member

This PR adds sphinx.ext.duration as 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.

@github-actions

github-actions Bot commented Aug 3, 2023

Copy link
Copy Markdown

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:

  • Try fixing CI / Python 3.11 test failures first.
  • Most pre-commit.ci - pr failures can be automagically fixed by commenting pre-commit.ci autofix below, followed by a git pull to bring the changes back to your computer.
  • If pre-commit.ci - pr says that a function is too long or complex, try breaking up that function into multiple short functions that each do one thing. See also these tips on writing clean scientific software.
  • If the CI / Documentation check ends with a cryptic error message, check out our documentation troubleshooting guide.
  • For a documentation preview, click on Details next to docs/readthedocs.org:plasmapy.

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!

@github-actions github-actions Bot added the docs PlasmaPy Docs at http://docs.plasmapy.org label Aug 3, 2023
@codecov

codecov Bot commented Aug 3, 2023 •

Copy link
Copy Markdown

Codecov Report

Patch and project coverage have no change.

Comparison is base (41887c4) 98.37% compared to head (ca633c4) 98.37%.
Report is 1 commits behind head on main.

❗ Current head ca633c4 differs from pull request most recent head 70f578e. Consider uploading reports for the commit 70f578e to get more accurate results

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.
📢 Have feedback on the report? Share it here.

@github-actions github-actions Bot added CI Related to continuous integration GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory) labels Aug 3, 2023
Comment thread .github/workflows/testing.yml Resolved
@github-actions github-actions Bot removed CI Related to continuous integration GitHub Actions A continuous integration platform for automating tests and other tasks (see .github/ directory) labels Aug 4, 2023
Comment thread changelog/2268.doc.rst Resolved
@namurphy
namurphy marked this pull request as ready for review August 4, 2023 21:42
@namurphy
namurphy requested a review from a team as a code owner August 4, 2023 21:42
@namurphy
namurphy requested review from JaydenR2305 and removed request for a team August 4, 2023 21:42
@namurphy

namurphy commented Aug 4, 2023

Copy link
Copy Markdown
Member Author

Merging this since it's a minimal change, and I plan to use it for another PR too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs PlasmaPy Docs at http://docs.plasmapy.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant