Skip to content

improve live code chapter #105

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

Open
rlanzafame opened this issue Feb 17, 2025 · 3 comments
Open

improve live code chapter #105

rlanzafame opened this issue Feb 17, 2025 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request waiting

Comments

@rlanzafame
Copy link
Member

propose to take current live code page and replace it with:

  • overview page explaining the tools we use and how to choose one for your application
  • subpages describing specific tools, at minimum one page for sphinx-thebe and jupyterlite

do this once teachbooks-sphinx-thebe is ready so that a high level description can be added. can also use documentation that is being prepared by Diana.

@rlanzafame rlanzafame added documentation Improvements or additions to documentation enhancement New feature or request waiting labels Feb 17, 2025
@rlanzafame rlanzafame self-assigned this Feb 17, 2025
@Tom-van-Woudenberg
Copy link
Member

Sure! Although before we deliberately removed the jupyterlite pages, but we can add them back in

@rlanzafame
Copy link
Member Author

oh good point, i'll take a look at those when we revise the chapter. part of the reason we removed them was that we gave up trying to embed the jupyterlite feature into the built book during the build process. we can try again (i'm curious), but at the moment i was only thinking of the "use it as a separate website/repo" situation (like the Learn Python calculator).

rlanzafame added a commit that referenced this issue Feb 17, 2025
@rlanzafame
Copy link
Member Author

if we use it in the book, add back jupyterlite-sphinx to requirements.txt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request waiting
Projects
None yet
Development

No branches or pull requests

2 participants