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

MRG: fix tutorial notebook links #2633

Merged
merged 9 commits into from
Jun 22, 2023
Merged

MRG: fix tutorial notebook links #2633

merged 9 commits into from
Jun 22, 2023

Conversation

ctb
Copy link
Contributor

@ctb ctb commented Jun 2, 2023

Fixes #2604

This PR fixes links to binder tutorials that apparently have been broken since 2020 😱 , when the docs were switched over to myst-parser in #1021.

To be fair, it's the kind of subtle bug that would leave users scratching their head going "maybe it's me?" - the links simply went back to the tutorial page... not sure why they weren't flagged by sphinx or myst-parser as being bad!?

This PR also updates environment.yml to properly build:

  • includes pip
  • specifies minimum python version
  • specifies minimum sourmash version

ref #2503 for why specifying the minimum sourmash and/or python versions can be important!

And, finally, I ran and fixed all the notebooks...

Note: I confirmed that this branch launches properly in binder. The URL is: https://mybinder.org/v2/gh/sourmash-bio/sourmash/fix/tutorial-nb

@codecov
Copy link

codecov bot commented Jun 2, 2023

Codecov Report

Merging #2633 (67399b0) into latest (c81d7ea) will increase coverage by 7.57%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           latest    #2633      +/-   ##
==========================================
+ Coverage   85.26%   92.83%   +7.57%     
==========================================
  Files         133      104      -29     
  Lines       15157    12389    -2768     
  Branches     2612     2612              
==========================================
- Hits        12923    11501    -1422     
+ Misses       1933      587    -1346     
  Partials      301      301              
Flag Coverage Δ
hypothesis-py 25.81% <ø> (ø)
python 92.83% <ø> (ø)
rust ?

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

see 29 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ctb ctb changed the title WIP: fix tutorial notebook links MRG: fix tutorial notebook links Jun 2, 2023
@ctb
Copy link
Contributor Author

ctb commented Jun 2, 2023

ready for review & merge, @sourmash-bio/devs !

@ctb
Copy link
Contributor Author

ctb commented Jun 22, 2023

bump @ccbaumler @bluegenes

@ccbaumler
Copy link
Contributor

The binder do not launch to the notebooks.

@ctb
Copy link
Contributor Author

ctb commented Jun 22, 2023

The binder do not launch to the notebooks.

thanks! fixed in 0e17b6e.

doc/tutorials.md Outdated Show resolved Hide resolved
doc/tutorials.md Outdated Show resolved Hide resolved
@ctb
Copy link
Contributor Author

ctb commented Jun 22, 2023

ok! This should be ready for review again, @ccbaumler - thx :)

@ctb
Copy link
Contributor Author

ctb commented Jun 22, 2023

oh, sorry, didn't see the latest comments! please hold :)

ctb and others added 2 commits June 22, 2023 14:21
Co-authored-by: ccbaumler <63077899+ccbaumler@users.noreply.github.com>
@ctb
Copy link
Contributor Author

ctb commented Jun 22, 2023

ready @ccbaumler !

@ccbaumler
Copy link
Contributor

LGTM

@ctb
Copy link
Contributor Author

ctb commented Jun 22, 2023

thank you!!

@ctb ctb merged commit 81a4a30 into latest Jun 22, 2023
@ctb ctb deleted the fix/tutorial-nb branch June 22, 2023 23:43
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.

links to tutorial notebooks are not working!?
2 participants