Closed lboegner closed 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)
This is the way to do it. Very, very awesome.
Adding titles within the table of contents and placeholder notebooks for tutorials I could see us wanting to include.
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.
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.
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:
Then opened
index.html
, clicked on the tutorial link, and verified the notebook was executed during documentation building.Note: this will still need to be verified within RTD and may require further updates to the
conf.py
or requirements to resolve.