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

Embed binder in AiiDA docs (via thebe)? #5065

Open
giovannipizzi opened this issue Aug 11, 2021 · 1 comment
Open

Embed binder in AiiDA docs (via thebe)? #5065

giovannipizzi opened this issue Aug 11, 2021 · 1 comment
Labels
type/feature request status undecided

Comments

@giovannipizzi
Copy link
Member

It would be interesting to see if one could use this sphinx plugin:
https://pypi.org/project/sphinx-thebe/
to have dynamic code blocks that can be executed on binder when the user wants, and if this would provide any learning benefit for the content of the documentation (e.g. for the how-tos?).

I'm just leaving this in case anybody wants to play with this in the free time; in any case, before doing anything full-fledged, I think we can check a mini proof-of-concept on 1 or 2 pages, to see if this would work well for AiiDA or not.

(Note: having a binder for AiiDA was also mentioned here: #3892 but I don't think we ever actually prepared a binder installation?)

@giovannipizzi giovannipizzi added the type/feature request status undecided label Aug 11, 2021
@chrisjsewell
Copy link
Member

You know that thebe is part of executablebooks, i.e. I’m one of the developers 😉
Any how yeh I already been playing around with this stuff, so you can probably expect something at some point

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/feature request status undecided
Projects
None yet
Development

No branches or pull requests

2 participants