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

Launch buttons cannot use git submodules #679

Open
adamgayoso opened this issue Feb 13, 2023 · 1 comment
Open

Launch buttons cannot use git submodules #679

adamgayoso opened this issue Feb 13, 2023 · 1 comment
Labels
bug Something isn't working

Comments

@adamgayoso
Copy link

adamgayoso commented Feb 13, 2023

Describe the bug

context
We keep ipynbs in a submodule that's cloned recursively for docs builds on readthedocs. I cannot set the html theme options properly to allow using a git submodule url for launching e.g., colab notebooks

expectation
I expect to be able to customize the launch url.

Reproduce the bug

html_theme_options = {
    "repository_url": repository_url,
    "use_repository_button": True,
    "logo_only": True,
    "show_toc_level": 4,
    "launch_buttons": {"colab_url": "https://colab.research.google.com"},
    "path_to_docs": "docs/",
    "repository_branch": version,
}

Will provide a url like

https://colab.research.google.com/github/scverse/scvi-tools/blob/0.20.0/docs/tutorials/notebooks/api_overview.ipynb

but docs/tutorials/notebooks/ is a submodule to https://github.com/scverse/scvi-tutorials and github/colab do not properly resolve this URL.

List your environment

No response

@adamgayoso adamgayoso added the bug Something isn't working label Feb 13, 2023
@adamgayoso
Copy link
Author

I see that #462 is related and would be a great fix for this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant