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

Go back to tutorial submodule #2636

Closed
ivirshup opened this issue Aug 24, 2023 · 4 comments · Fixed by #2901
Closed

Go back to tutorial submodule #2636

ivirshup opened this issue Aug 24, 2023 · 4 comments · Fixed by #2901

Comments

@ivirshup
Copy link
Member

What kind of feature would you like to request?

Other?

Please describe your wishes

The tutorial submodule was removed as part of a fix-up pass over the docs by @flying-sheep.

The issue at the time was warnings which weren't immediately obvious how to fix.

Since there are a number of reasons to prefer the submodule approach over a separate scanpy-tutorials website, I would like to bring it back.

The plan is: bring back the submodule. In this PR I'll see if the warnings can be easily fixed. If they can't, they'll be silenced and an issue tracking fixing them for the next release will be opened.

@flying-sheep
Copy link
Member

Let’s coordinate here and come up with what we think is the best strategy:

@ivirshup
Copy link
Member Author

Since we already made the decision to use a submodule in scanpy (why it was that way) I don't think we need to discuss more before going back to it. Still happy to have discussions about better ways to do things, but we've already established a setup and workflow.

@flying-sheep
Copy link
Member

flying-sheep commented Aug 24, 2023

Sure, I just suggested that since I don‘t feel like it’s worth the effort:

  1. submodules are a temporary solution (to be replaced by the one we’ll settle on in the linked issue)
  2. the current solution works well enough (intersphinx makes sure links are valid and have a nice default text)

If you feel it’s important enough to switch to it for the next few weeks, it would be nice to settle on a canonical URL for each of the tutorials, i.e. that the tutorials on https://scanpy-tutorials.readthedocs.io redirect to the ones on https://scanpy.readthedocs.io. Otherwise some people will link to one version, others to the other.

@flying-sheep
Copy link
Member

After @ilan-gold mentioned that scanpy’s tutorials are actually not reproducible, I made an issue for that: scverse/scanpy-tutorials#79

Maybe we need to address that before the release, that’ll also get rid of the warnings.

If you need to suppress them, I think this extension could be an acceptable solution: https://github.com/picnixz/sphinx-zeta-suppress

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants