question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Consider moving the tutorial to a Jupyter notebook

See original GitHub issue

Would others be interested in having the content in tutorial.rst moved to a Jupyter notebook? We could then use the nbsphinx Sphinx extension (https://nbsphinx.readthedocs.io) to run and render the notebook in the docs.

The main advantage I see to the .rst -> .ipynb move would be to easily run the tutorial interactively on Binder (we could include a binder link at the top of the tutorial). The main drawback that comes to mind is editing the tutorial would now be different than editing all the other *.rst files we currently have in the docs (and adds Jupyter as a dependency to build the docs).

Happy to open a PR for this, just wanted to see if there was any interest first

Issue Analytics

  • State:open
  • Created 4 years ago
  • Comments:20 (18 by maintainers)

github_iconTop GitHub Comments

2reactions
rabernatcommented, Mar 30, 2022

In order to integrate the notebook into the docs, I highly recommend myst-nb. We use it on all our documentation sites. It supports all of the fancy sphinx syntax in markdown via myst.

1reaction
jakirkhamcommented, Oct 21, 2022

Hi Stephanie, thanks for offering to help! 🙏

Think Emmanuel already picked this up with PR ( https://github.com/zarr-developers/zarr-python/pull/1163 ), but please feel free to grab another issue.

Thanks again! 🙂

Read more comments on GitHub >

github_iconTop Results From Across the Web

Jupyter Notebook Tutorial: Introduction, Setup, and Walkthrough
In this Python Tutorial, we will be learning how to install, setup, and use Jupyter Notebooks. Jupyter Notebooks have become very popular in ......
Read more >
Jupyter Notebook Tutorial - YouTube
Never miss a tutorial ! Subscribe to the Project Data Science channel: https://bit.ly/3yTMdQVGo from zero to hero with our Data Science ...
Read more >
Jupyter Notebook Complete Beginner Guide 2023 - YouTube
Jupyter notebooks and python notebooks are an important tool for data science. If you want to learn about them this is the ultimate...
Read more >
Introduction to Jupyter Notebook - YouTube
We'll cover how to install Jupyter and then walkthrough its core ... Introduction to Jupyter Notebook | Jupyter Notebook Tutorial.
Read more >
Jupyter Notebook Tutorial for Beginners with Python - YouTube
This Jupyter Notebook Tutorial for Beginners with Python provides a set up, introduction, and quick start for Jupyter Notebooks.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found