docs: split the reference into Guides and API, and fix the Windows setup - #13
Merged
Merged
Conversation
The reference mixed the API with explanations of when to use each argument. It is now two pages: guides.md (frames by number, approximate frames, threads, hardware decoding, frames on the GPU) and api.md (signatures, arguments, errors, types, constants). A MkDocs hook writes reference/index.html, which sends each old anchor to the page that now holds it, so the links in the README of released versions keep working. The quick start gains random access in any order, device="auto", reading videos in parallel, and when errors are raised. The Windows setup in development.md explains that pacman is MSYS2's, adds uv's tool directory to PATH for meson and ninja, and renames MSYS2's link.exe instead of deleting it. The layout table lists build.rs, src/dlpack.rs, and web/. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
alesanfra
force-pushed
the
docs/api-and-guides
branch
from
September 28, 2026 20:20
2e5b8c9 to
4860378
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
reference.mdis split intoguides.md(frames by number, approximate frames, threads, hardware decoding, frames on the GPU) andapi.md(signatures, arguments, errors,FrameReader,Frame,Batch, constants). The text is moved unchanged; only the links between the pages differ.scripts/docs_redirects.py, a MkDocs hook, writesreference/index.html, which sends each old anchor to the page that now holds it (for example#hardware-decodingtoguides/,#errorstoapi/). The README on PyPI for 0.6.0 and earlier links toreference/five times. mkdocs-redirects would keep the anchor but send every one to a single page, so it is not used.frames=[-1],device="auto", reading videos in parallel with threads, and a note that errors are raised by the firstnext().pacmanis MSYS2's package manager and puts uv's tool directory onPATHfor meson and ninja, as CI does. It renames MSYS2'slink.exeinstead of deleting it. The layout table listsbuild.rs,src/dlpack.rs, andweb/.Frameexposes through the buffer protocol and what that saves: no copy per frame, C-contiguous arrays, batches in one block, and writable memory that the decoder never touches again.AGENTS.mdpoint to the new pages, andtests/test_read.pynamesguides.mdwhere it citedreference.md.The change of license moved to its own pull request.
The new quick start examples were run against the test video.
mkdocs build --strictpasses, and the redirect script was checked for guide anchors, API anchors, and no anchor. The Windows steps have not been run on Windows.Checklist
cargo fmtandcargo clippy --all-targets -- -D warningspass (no Rust changes)uv run --no-sync pre-commit run -apassesuv run --no-sync pytestpasses (docs only)CHANGELOG.mdupdated (the changelog is written by release-please)🤖 Generated with Claude Code