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

Draft usage of pixi task for notebook analysis. #87

Merged
merged 3 commits into from
Aug 27, 2024
Merged

Conversation

kklein
Copy link
Collaborator

@kklein kklein commented Aug 27, 2024

This PR should make it a little more convenient to reproduce the behaviour of the mypy-example-nbs CI job locally.

Checklist

  • Added a CHANGELOG.rst entry

Copy link

codecov bot commented Aug 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.42%. Comparing base (fccde2c) to head (0506c8c).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #87   +/-   ##
=======================================
  Coverage   94.42%   94.42%           
=======================================
  Files          15       15           
  Lines        1793     1793           
=======================================
  Hits         1693     1693           
  Misses        100      100           

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


🚨 Try these New Features:

@kklein kklein marked this pull request as ready for review August 27, 2024 09:42
@kklein kklein requested a review from pavelzw August 27, 2024 09:42
Copy link
Member

@pavelzw pavelzw left a comment

Choose a reason for hiding this comment

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

for easier reproducible notebooks i suggest taking a look at https://marimo.io/ 😉 it's a neat project

@kklein
Copy link
Collaborator Author

kklein commented Aug 27, 2024

for easier reproducible notebooks i suggest taking a look at https://marimo.io/ 😉 it's a neat project

Thanks for the pointer! Do you happen to know whether it integrates with mkdocs/sphynx, too?

Our main reason for using jupyter notebooks right now is to be able to generate code-heavy examples for our docs.

@pavelzw
Copy link
Member

pavelzw commented Aug 27, 2024

Do you happen to know whether it integrates with mkdocs/sphynx, too?

There are marimo islands (docs) that can generate HTML that can be easily embedded.
Otherwise you could use their web app to create an embed (see https://github.com/pyodide/pyodide-blog/blob/34de33029ee9246e507b1f9621f9239cea27ee8f/content/posts/marimo.md?plain=1#L72) but this is a bit clunky if your example code is in your repo.

But I don't think that the tooling is there yet to autogenerate mkdocs or sphinx content.
If I find some time in the future, looking into a mkdocs plugin is on my todo list.

xref https://discord.com/channels/1059888774789730424/1214483174361534474/1214561254035951636, https://discord.com/channels/1059888774789730424/1227738354175578203/1262785309201137734, marimo-team/marimo#1882 (comment)

@kklein kklein merged commit 14fef77 into main Aug 27, 2024
16 checks passed
@kklein kklein deleted the nb-mypy-pixi branch August 27, 2024 09:59
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