Skip to content

docs: link the PyIBS film from the README and the documentation - #10

Merged
lacerbi merged 1 commit into
mainfrom
docs-film
Oct 19, 2026
Merged

lacerbi merged 1 commit into
mainfrom
docs-film

Conversation

@lacerbi

@lacerbi lacerbi commented Oct 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • The introduction of README.md and docsrc/source/index.rst shows the film's thumbnail, linking its YouTube upload (https://www.youtube.com/watch?v=qj2P8aDTeWs), with the line "Watch a four-minute film that explains how PyIBS works."
  • "How does it work?" opens with the same link, in the README as a bold line and in the documentation as a tip.
  • The thumbnail, docsrc/source/_static/pyibs-film-thumbnail.jpg (1280 x 720, 42 kB), is the frame that YouTube shows for the video (1:53.3), with the play button of the PyBADS and PyVBMC thumbnails drawn on it. The README names it by its address on main, as it names its figure, so it shows on GitHub once this is merged and on PyPI with the next release.

Checks

  • make -C docsrc github builds without warnings; the index page shows the thumbnail centred, 560 px wide, under "What is it?".

After merging

Check that the README's thumbnail and links open the video on GitHub, and that the published index page does once docs.yml has run.

🤖 Generated with Claude Code

https://claude.ai/code/session_014GYQicYVJPhB3S9XtRiePi

The introduction of README.md and index.rst shows the film's thumbnail, the frame that YouTube shows with a play button drawn on it, linking the YouTube upload (https://www.youtube.com/watch?v=qj2P8aDTeWs), and "How does it work?" opens with a link to it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@lacerbi
lacerbi merged commit a4efd35 into main Oct 19, 2026
2 checks passed
@lacerbi
lacerbi deleted the docs-film branch October 19, 2026 18:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant