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

Moving tutorial.rst to tutorial.ipynb #996

Closed
wants to merge 4 commits into from
Closed

Moving tutorial.rst to tutorial.ipynb #996

wants to merge 4 commits into from

Conversation

sudoyolo
Copy link

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
Copy link
Member

sanketverma1704 commented Mar 31, 2022

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'.

@sudoyolo sudoyolo changed the title Tutorial Moving tutorial.rst to tutorial.ipynb Apr 1, 2022
@jakirkham
Copy link
Member

Maybe we should look at using sphinx-gallery or something

@joshmoore
Copy link
Member

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

@sudoyolo sudoyolo closed this by deleting the head repository Sep 14, 2022
@joshmoore
Copy link
Member

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
Copy link
Contributor

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

@joshmoore
Copy link
Member

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
Copy link

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

@sanketverma1704
Copy link
Member

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. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants