Adding notebooks to docs
What type of PR is this? (check all applicable)
- [ ] ๐พ Refactor
- [ ] ๐ช Feature
- [ ] ๐ Bug Fix
- [ ] ๐ง Optimization
- [x] ๐ Documentation
- [ ] ๐งช Test
- [ ] ๐ ๏ธ Other
Related issues
- Closes #710
Checklist
- [x] Code follows style guide
- [ ] Tests added
- [ ] Documented the changes
Please explain your changes below.
@hameerabbasi, could you review this whenever free? I've added the "Notebooks" section in nav (and it's visible, but not on the home page with an icon just like other sections). Currently, there are also some failures in the Jupyter notebook itself.
CodSpeed Performance Report
Merging #894 will degrade performances by 44.45%
Comparing prady0t:notebooks (a2044dc) with main (3a2e703)
Summary
โ 1 regression
โ
339 untouched
:warning: Please fix the performance issues or acknowledge them on CodSpeed.
Benchmarks breakdown
| Benchmark | BASE |
HEAD |
Change | |
|---|---|---|---|---|
| โ | test_index_slice[side=100-rank=2-format='gcxs'] |
1.8 ms | 3.2 ms | -44.45% |
Also please rebase on master.
Maybe we can just not run the notebook in docs? These dependency errors are basically because mkdocs-jupyter runs the notebook in a fresh Jupyter Kernel (not in the current env). There could be a workaround for this but I don't think running them in docs is that necessesary. Especially when we can easily open them in Google Colab from the same page.
The better approach would be to have the standalone notebook files so they do not depend on the sparse envs. I've pushed the changes with execute disabled, let me know your thoughts.