Skip to content

Conversation

Andy-Grigg
Copy link
Collaborator

@Andy-Grigg Andy-Grigg commented May 29, 2025

Closes #804

  • Fix some incorrect notebook formatting, probably as a result of upgrading jupytext
  • Revert the bump to plotly, which was causing plots to fail to render in HTML generated from notebooks

I did not modify the sustainability notebook which was the trigger for the underlying issue, this is fixed in #803

TODO:

@github-actions github-actions bot added documentation Improvements or additions to documentation dependencies Related with project dependencies labels May 29, 2025
Copy link

codecov bot commented May 29, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.88%. Comparing base (b09c4f9) to head (3961afc).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #805   +/-   ##
=======================================
  Coverage   97.88%   97.88%           
=======================================
  Files          28       28           
  Lines        3124     3124           
=======================================
  Hits         3058     3058           
  Misses         66       66           
Flag Coverage Δ
integration-ubuntu-latest-TEST_SERVER_24R2_URL 81.37% <ø> (ø)
integration-ubuntu-latest-TEST_SERVER_25R1_URL 81.37% <ø> (ø)
integration-ubuntu-latest-TEST_SERVER_25R2_URL 87.54% <ø> (ø)
integration-ubuntu-latest-TEST_SERVER_DEV_URL 87.54% <ø> (ø)
integration-windows-latest-TEST_SERVER_24R2_URL 81.37% <ø> (ø)
integration-windows-latest-TEST_SERVER_25R1_URL 81.37% <ø> (ø)
integration-windows-latest-TEST_SERVER_25R2_URL 87.54% <ø> (ø)
integration-windows-latest-TEST_SERVER_DEV_URL 87.54% <ø> (ø)
unittests 97.53% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Andy-Grigg Andy-Grigg changed the title Doc/fix example formatting Fix some broken example notebook layouts May 29, 2025
@Andy-Grigg
Copy link
Collaborator Author

Andy-Grigg commented May 30, 2025

Going through the process manually (i.e. creating an ipynb from the .py file in jupyter, running the example, then exporting to HTML) seems to work, although it generates static plots instead of the interactive ones we get currently.

I think there's some more investigation needed to resolve this. To unblock us though, I think we should merge this, and I'll create a separate issue to investigate what's going on with plotly >=6.1.

I don't think it's necessary to pin to an earlier version in pyproject.toml, since plotly still works when running the examples. It's just that as part of our CI, it doesn't do what we expect.

@Andy-Grigg Andy-Grigg marked this pull request as ready for review May 30, 2025 12:44
@Andy-Grigg Andy-Grigg requested a review from da1910 May 30, 2025 12:47
@Andy-Grigg Andy-Grigg changed the title Fix some broken example notebook layouts Address example notebook formatting issues May 30, 2025
@Andy-Grigg Andy-Grigg added this pull request to the merge queue May 30, 2025
Merged via the queue into main with commit aa6b299 May 30, 2025
54 checks passed
@Andy-Grigg Andy-Grigg deleted the doc/fix-example-formatting branch May 30, 2025 14:51
Andy-Grigg added a commit that referenced this pull request Jun 5, 2025
Andy-Grigg added a commit that referenced this pull request Jun 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Related with project dependencies documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Notebook formatting issues in dev docs
3 participants