TensorRT icon indicating copy to clipboard operation
TensorRT copied to clipboard

✨[Feature] Port notebooks to sphinx-gallery

Open narendasan opened this issue 3 years ago • 2 comments

Is your feature request related to a problem? Please describe.

Notebooks right now have a few issues including:

  • Notebooks must be run AOT to avoid triggering execution during documentation building
  • Notebooks do not currently render properly
  • Notebook outputs have excessive amounts of text

Describe the solution you'd like

PyTorch uses sphinx-gallerynotebook styled examples which are just python files with comments: https://sphinx-gallery.github.io/stable/tutorials/index.html. We can also link to CoLab so users can try the notebooks out in browser.

Describe alternatives you've considered

Additional context

https://github.com/pytorch/tutorials https://sphinx-gallery.github.io/stable/tutorials/plot_parse.html#sphx-glr-tutorials-plot-parse-py

narendasan avatar May 27 '22 22:05 narendasan

cc: @tanayvarshney

narendasan avatar May 27 '22 22:05 narendasan

This issue has not seen activity for 90 days, Remove stale label or comment or this will be closed in 10 days

github-actions[bot] avatar Sep 16 '22 00:09 github-actions[bot]

This issue has not seen activity for 90 days, Remove stale label or comment or this will be closed in 10 days

github-actions[bot] avatar Mar 16 '23 00:03 github-actions[bot]