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

DOC: auto generate doc images and code outputs #446

Merged
merged 9 commits into from
Jan 3, 2025

Conversation

mj-will
Copy link
Owner

@mj-will mj-will commented Dec 20, 2024

This PR updates the docs to auto-generate plots and code outputs.

This makes it easier to keep the documentation up-to-date.

@mj-will mj-will added the documentation Improvements or additions to documentation label Dec 20, 2024
@mj-will mj-will added this to the v0.14.0 milestone Dec 20, 2024
@mj-will mj-will linked an issue Dec 20, 2024 that may be closed by this pull request
Copy link

codecov bot commented Dec 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.89%. Comparing base (1ff98a9) to head (d844216).
Report is 10 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #446   +/-   ##
=======================================
  Coverage   93.89%   93.89%           
=======================================
  Files          72       72           
  Lines        7027     7027           
=======================================
  Hits         6598     6598           
  Misses        429      429           
Flag Coverage Δ
unittests 93.89% <ø> (ø)

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.

@mj-will mj-will merged commit a54c870 into main Jan 3, 2025
29 checks passed
@mj-will mj-will deleted the auto-generate-doc-images branch January 3, 2025 16:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update images in docs
1 participant