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

documentation beef up (incl. example gallery and badge generation) #1407

Merged
merged 15 commits into from
Nov 10, 2024

Conversation

pawelmagnu
Copy link
Collaborator

No description provided.

@slayoo
Copy link
Member

slayoo commented Nov 1, 2024

Kudos @pawelmagnu
Among TODOs, we have:

  • move tutorial snippets out of README into subsections of PySDM landing page
  • make the moved snippets being executed on CI
  • introduce badges into __init__.py for all examples
  • populate examples table with keywords

Copy link

codecov bot commented Nov 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.60%. Comparing base (4c0f146) to head (075fd42).
Report is 7 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1407   +/-   ##
=======================================
  Coverage   84.60%   84.60%           
=======================================
  Files         375      375           
  Lines        9248     9248           
=======================================
  Hits         7824     7824           
  Misses       1424     1424           

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

@slayoo slayoo changed the title added example gallery and badge generation documentation beef up (incl. example gallery and badge generation) Nov 9, 2024
@slayoo slayoo merged commit 4315ea3 into open-atmos:main Nov 10, 2024
95 of 149 checks passed
@pawelmagnu pawelmagnu deleted the docs branch November 11, 2024 20:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants