Jupyter Notebooks for Tutorials(USER GUIDE)
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
This issue is more of a suggestion.
A small issue that users reading documentation face is unavailability of jupyter notebooks for the tutorial docs User Guide. User constantly has to copy paste code from the documentation or .rst file which results in wastage of time.
Having executable notebooks for new users would help them save time and quickly move on to using xarray for their specific tasks.It would ease the learning process for new users which may somehow bring more contributors to xarray community.
Let's take example of pyviz, holoviews, pytorch.
00 Setup — PyViz 0.10.0 documentation
holoviews/examples/user_guide at master · pyviz/holoviews · GitHub
Chatbot Tutorial — PyTorch Tutorials 1.1.0.dev20190507 documentation
All of them provide option to download the tutorial in the form of .ipynb file either in the beginning or end of the notebook.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the User Guide tutorial pages, especially data-structures.html, and compare the linked PyViz, HoloViews, and PyTorch notebook examples. Define which tutorials need executable notebooks and how users will download them; the work is done when the selected tutorials have usable, downloadable .ipynb files.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100