Moving tutorial.rst to tutorial.ipynb

[sudoyolo]

trafficstars

Hi everyone! This is in reference to #514. I added the Jupyter Notebook in the Docs directory. I have not yet integrated the notebook with the readdocs output, its a WIP.

TODO:

• [ ] Add unit tests and/or doctests in docstrings
• [ ] Add docstrings and API docs for any new/modified user-facing classes and functions
• [ ] New/modified features documented in docs/tutorial.rst
• [ ] Changes documented in docs/release.rst
• [ ] GitHub Actions have all passed
• [ ] Test coverage is 100% (Codecov passes)

[sanketverma1704]

Thanks for submitting the PR @sudoyolo. Might I suggest changing the title of the PR to something more informative like, 'Moving tutorial.rst to tutorial.ipynb'.

[jakirkham]

Maybe we should look at using sphinx-gallery or something

[joshmoore]

If we were to use jupyterbook, https://jupyterbook.org/interactive/comments/utterances.html would be an option! :smile:

[joshmoore]

Thanks again for the notebook, @sudoyolo. I think we're all still excited about the idea of embedding a notebook in the docs. If you (or anyone else finds time) for that integration, let us know. 🙇🏽

[GbotemiB]

Hi @joshmoore I am from Outreachy and I will like to work on integrating the notebook into readthedocs.

[joshmoore]

Glad to hear it, @GbotemiB. For learning more about jupyter book, you might take a look at the original blog post: https://blog.readthedocs.com/jupyter-book-read-the-docs/

[melissakirabo]

Hi @joshmoore, I am from Outreachy as well and I am interested on taking on the notebook integration into readthedocs.

[sanketverma1704]

Hi @joshmoore, I am from Outreachy as well and I am interested on taking on the notebook integration into readthedocs.

Hi @melissakirabo. Welcome, and thanks for your interest in Zarr. Please refer to the blog post here: https://zarr.dev/blog/outreachy-contributer-guide/

We'll be over at Gitter to answer your questions. :)