Presentation Slides

Each of the four parts has a slide deck covering its theory section, for presenting the material in a session. The decks are deliberately sparse — they carry the diagrams, while the detail stays here in the written curriculum and in each slide’s speaker notes.

Deck

Covers

Part 1: Git Basics

commits, branches, and the seven-step workflow

Part 2: Testing

unit tests, refactoring, CI, and test-driven development

Part 3: Documentation

README, reStructuredText, Sphinx, docstrings, and publishing

Part 4: Python Packaging

packages, pyproject.toml, entry points, tox, and linting

Presenting them

The decks run in a browser — no software to install, and they work offline.

Key

Does

Arrow keys, Space

next / previous slide

S

speaker view: notes, a timer, and the next slide

F

fullscreen

Esc

zoom out to an overview of every slide

Tip

To hand out a deck as a PDF, just print the page from your browser (Ctrl + P, or Cmd + P on a Mac) and choose Save as PDF. You get one slide per page.

Some reveal.js guides tell you to add ?print-pdf to the address first. Don’t — this build doesn’t ship that stylesheet, and it produces a blank page. Plain printing is what works here.

Note

The speaker view opens in a second browser window. If nothing appears when you press S, your browser has blocked the pop-up — allow pop-ups for the site and press it again.

Editing them

The decks are written in reStructuredText, like the rest of this site, and live in docs/slides/. One == heading starts a deck, each -- heading is one slide, and a .. revealjs-notes:: block holds the speaker notes for the slide above it.

Build them with:

cd docs
make html
make slides

make slides writes into _build/html/slides/, so run make html first. On every push to main, GitHub Actions runs both and publishes the result.

The diagrams are plain SVG files in docs/slides/figures/, editable in any text editor or vector program. The eight Part 1 workflow diagrams are generated — edit the step names in docs/slides/figures/_generate_cycle.py and re-run it to keep them consistent.