Repository navigation
Docs: restructure to Get started, Guides, Reference, How it works - #51
Merged
Merged
Conversation
MyST Markdown, autodoc with Google-style docstrings, the shared top bar and theme, and the live demos carried across. A docs workflow builds the site with sphinx-build -W, as Read the Docs does. Docstring-only edits so the reference builds without warnings.
… Changelog The README now leads with an image, one sentence, the install commands and a short example with its output. The docs tree is split into Get started, Guides, Reference, How it works and Changelog; the newcomers page becomes the first How-it-works page. Building and release notes move to CONTRIBUTING.md, and the benchmark script behind the numbers is in tools/benchmark.py. Every code example on these pages was run on CPython and MicroPython, with both the compiled and the pure-Python package.
# Conflicts: # README.md # docs/README.md # docs/api-overview.md # docs/building-wheels.md # docs/getting-started.md # docs/graphics-guide.md # docs/index.md
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.
Restructures the README and the docs around what a reader comes to do.
The README leads with the picture the example draws, one sentence on what pygraphics is, the install commands, a 20-line example with its output, and one links line. The docs tree becomes:
Building, wheels and releases move to
CONTRIBUTING.md.tools/benchmark.pyis the script behind the benchmark table, so anyone can rerun it.Every example on these pages was run on CPython with the compiled wheel and with the pure package, and on MicroPython with the module built in and with the pure package. The outputs shown are the ones those runs printed.
Things to know before merging
main.save()fails until Pure package: save, export and from_file work on MicroPython #50 lands.micropipline on the install page was not run.installation,getting-started,graphics-guide,graphics-files,api-overview,benchmarks,building-wheels,newcomers). Read the Docs redirects for them would keep old links working.modframebuf.cmoves from the README to How it works.main) edited the README this PR replaces, so retargeting tomainwill show a README conflict; this README already has no version number in it to go stale.