This repository was archived by the owner on Oct 28, 2026. It is now read-only.
Repository navigation
Docs: the shared README shape, and a Read the Docs site - #243
Merged
Merged
Conversation
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
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 opensdocs/index.mdon GitHub, where every page is listed. They also build with Sphinx throughpydevices_docs.configure, in four sections (there is no changelog yet):newcomers.md, with how casting works.CONTRIBUTING.mdis new. The gallery,deploy.yml,tools/,packages/and the example code are unchanged. Nothing in the gallery build readsdocs/, anddocs/screenshots/anddocs/videos/stay where they were.Claims checked against the code:
time,machine.Pin,utime,asyncioandmicropython.constin memory. It edits nothing undergui/and nothing aboutFrameBuffer.hardware_setup._KEYMAP), not Tab and Enter.lib/utils, notsrc/utils.TV_ADDRESSrather than a fixed address.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:
pip install -r requirements.txtfrom TestPyPI ran.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.pyandtools/serve.pyran.sphinx-build -W --keep-going -b html docsexits 0.Not run here: casting to a TV, and
mipon 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.