Where Docs, Cloud-hosted Interactive Tutorials and CI Testing Intersect

on YouTube ↗19m

" summary

Uses Jupyter notebooks as single-source examples, with Sphinx to render docs, a separate GitHub repo for examples, and a lightweight CLI that fetches examples, strips exercise/solution/testing tags, and installs helper code for local use. Builds HTML for Read the Docs and GitHub Pages, runs notebooks as CI regression tests, and deploys zero‑install cloud tutorials using AWS auto-scaling. Custom build scripts glue the flows; workflows already scale to about 30–40 simultaneous users and validate code before commit.

AI-written summary · about

" chapters (12)

1. 0:00Intro
2. 0:57Background
3. 3:18Tools and Technologies (1) SPHINX
4. 4:13Tools and Technologies (2) jupyter notebooks
5. 5:31Step o. Github "examples" repository
6. 6:33Add "lags" to Jupyter Notebooks
7. 8:46Create "build" script for different workflows
8. 10:26a. Deployment of the does
9. 11:57Step 3b. Deployment to users' machines
10. 13:08Step 3c. Deployment to the cloud
11. 14:37Summary
12. 15:13Parting thoughts

" related talks

• 23mTreating Documentation like Code: a Practical AccountJodie Putrino · Write the Docs 2017
• 35mBuilding Docs like Code: Continuous Integration for DocumentationMason Egger · PyCon US 2020
• 36mBuilding Docs like Code: Continuous Integration for DocumentationMason Egger · PyCon Latam 2019
• 33mWrite the Docs!Hareem Naveed · PyData Los Angeles 2019
• 34mCode the Docs: Interactive Document EnvironmentsParis Buttfield-Addison · PyCon AU 2016
• 28mCode the Docs: Interactive Document EnvironmentsParis Buttfield-Addison, Tim Nugent · Write the Docs North America 2016
• 42mEngineering DocumentationLorna Jane Mitchell · YOW! Melbourne 2022
• 27mPractical SphinxCarol Willing · PyCon 2018