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

ENH: Always write sg_execution_times and make DataTable #1198

Merged
merged 12 commits into from Sep 22, 2023

Conversation

larsoner
Copy link
Contributor

In MNE-Python we only execute examples that have been changed. I'd like to link CircleCI artifacts redirector action to sg_execution_times.htmtl, but this only exists if any examples have been executed. It's easy enough to just always write this file (the cost is very low), so I figure we might as well do it.

@larsoner larsoner changed the title ENH: Always write sg_execution_times ENH: Always write sg_execution_times and make DataTable Sep 21, 2023
@larsoner
Copy link
Contributor Author

larsoner commented Sep 21, 2023

Okay I also made it much more usable by injecting some JS and scoped CSS to make it a DataTable. I've always wanted to be able to sort by computation time or memory usage and now I can! And it comes with nice stuff like pagination and search for free:

https://output.circle-artifacts.com/output/job/ffe304c1-792d-40b9-8710-60d0d6656f6f/artifacts/0/html/sg_execution_times.html

https://output.circle-artifacts.com/output/job/43069124-f7a6-424f-bb0f-49ce092ccfef/artifacts/0/html/sg_execution_times.html

@larsoner
Copy link
Contributor Author

@lucyleeow ready for review/merge from my end

Copy link
Contributor

@lucyleeow lucyleeow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the datatable looks great!

sphinx_gallery/tests/test_full.py Show resolved Hide resolved
@larsoner larsoner enabled auto-merge (squash) September 22, 2023 13:34
@larsoner
Copy link
Contributor Author

Thanks @lucyleeow pushed a commit to update the comments and marking for merge when green

@larsoner larsoner merged commit e2903c9 into sphinx-gallery:master Sep 22, 2023
17 checks passed
clrpackages pushed a commit to clearlinux-pkgs/pypi-sphinx_gallery that referenced this pull request Nov 28, 2023
… to version 0.15.0

v0.15.0
-------

Support for Python 3.7 dropped in this release. Requirement is now Python >=3.8.
Pillow added as a dependency.

**Implemented enhancements:**

-  ENH: Improve logging visibility of errors and filenames `#1225 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1225>`__ (`larsoner <https://github.com/larsoner>`__)
-  ENH: Improve API usage graph `#1203 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1203>`__ (`larsoner <https://github.com/larsoner>`__)
-  ENH: Always write sg_execution_times and make DataTable `#1198 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1198>`__ (`larsoner <https://github.com/larsoner>`__)
-  ENH: Write all computation times `#1197 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1197>`__ (`larsoner <https://github.com/larsoner>`__)
-  ENH: Support source files in any language `#1192 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1192>`__ (`speth <https://github.com/speth>`__)
-  FEA Add examples recommender system `#1125 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1125>`__ (`ArturoAmorQ <https://github.com/ArturoAmorQ>`__)

(NEWS truncated at 15 lines)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants