TorchDSP / torchsig

TorchSig is an open-source signal processing machine learning toolkit based on the PyTorch data handling pipeline.
MIT License
170 stars 38 forks source link

Tutorial notebook template in RTD #157

Closed lboegner closed 1 year ago

lboegner commented 1 year ago

Summary

This PR includes a template for how we can include tutorial notebooks within our documentation, where the notebooks remain unexecuted in our repo but get built during the documentation building process. Inspired by #150 .

Test Plan

Verified locally with:

cd docs
make html

Then opened index.html, clicked on the tutorial link, and verified the notebook was executed during documentation building.

TutorialNotebookScreenshot

Note: this will still need to be verified within RTD and may require further updates to the conf.py or requirements to resolve.

lboegner commented 1 year ago

Note: I'm not sure why the Tutorial NB tab disappeared once the NB was clicked on. At the home page, you can see it is visible on the side, but we should resolve this (at least before merging develop into main next)

Screen Shot 2023-07-23 at 7 04 16 AM
gvanhoy commented 1 year ago

This is the way to do it. Very, very awesome.

lboegner commented 1 year ago

Adding titles within the table of contents and placeholder notebooks for tutorials I could see us wanting to include.

Screen Shot 2023-07-29 at 7 29 17 AM
lboegner commented 1 year ago

Added a few more sub-titles in the table of contents to differentiate dataset, transform, and ML tutorials. Added sub-directories in the docs/ folder similarly.

Screen Shot 2023-07-30 at 10 38 58 AM
gvanhoy commented 1 year ago

There's probably more to do here, but thank you for your tremendous patience here and diligence in putting this together. Merged into v0.4.2.