Skip to content
This repository was archived by the owner on Oct 28, 2026. It is now read-only.

Docs: the shared README shape, and a Read the Docs site - #243

Merged
bdbarnett merged 5 commits into
mainfrom
docs/template
Oct 27, 2026
Merged

bdbarnett merged 5 commits into
mainfrom
docs/template

Conversation

@bdbarnett

@bdbarnett bdbarnett commented Oct 27, 2026 •

Copy link
Copy Markdown
Collaborator

The README now follows the shape shared across PyDevices repositories: a lead image, one sentence, the desktop and board installs, a 20-line example with its output, and links to the docs, the gallery and the roadmap. The Alpha banner, the layout table and the related-repositories list leave the README. That list moves to How it works.

The docs are Markdown under docs/: the README's Docs link opens docs/index.md on GitHub, where every page is listed. They also build with Sphinx through pydevices_docs.configure, in four sections (there is no changelog yet):

  • Get started: install, and a first program.
  • Guides: run in the browser, cast to a TV, use a Peter Hinch GUI, run the TFT examples.
  • Reference: package names, cast runtimes, screenshots.
  • How it works: made from newcomers.md, with how casting works.

CONTRIBUTING.md is new. The gallery, deploy.yml, tools/, packages/ and the example code are unchanged. Nothing in the gallery build reads docs/, and docs/screenshots/ and docs/videos/ stay where they were.

Claims checked against the code:

  • The Peter Hinch GUI fetcher patches time, machine.Pin, utime, asyncio and micropython.const in memory. It edits nothing under gui/ and nothing about FrameBuffer.
  • The Micro-GUI keys are Right, Left, Space, Up and Down (hardware_setup._KEYMAP), not Tab and Enter.
  • The Peter Hinch GUI download extracts into lib/utils, not src/utils.
  • The cast guide names TV_ADDRESS rather than a fixed address.
  • The link to pyscript-template's packages page follows its move to docs/guides/bring-in-a-bigger-app.md, which arrives with Docs: the shared README shape, and docs/ in five sections pyscript-template#14.

What ran:

  • The clone and the pip install -r requirements.txt from TestPyPI ran.
  • The example ran under Xvfb and printed drawing on a 320x480 display; the lead image is from that run.
  • mip.install("pydevices", ...) ran on the unix port.
  • lib/examples/pydevices_demo.py, examples/hello.py and tools/serve.py ran.
  • sphinx-build -W --keep-going -b html docs exits 0.

Not run here: casting to a TV, and mip on a real board.

The frame-rate and latency figures in the cast guide and the cast-runtimes table have no record in the repository yet, and are being re-measured. The clone sizes in Install were re-measured: 68 MB shallow, 270 MB full.

@bdbarnett
bdbarnett merged commit 76bb588 into main Oct 27, 2026
4 of 5 checks passed
@bdbarnett
bdbarnett deleted the docs/template branch October 27, 2026 07:38
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant