Repository navigation
Move the documentation from the wiki to a docs site - #96
Merged
Merged
Conversation
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
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.
The documentation moves from the GitHub wiki to a site built with yardang and published to GitHub Pages, as dau-scheduler and dau-core did.
add_docs: true,add_wiki: falseat the existing template commit, applied as rendered: the docs workflow replaces the wiki workflow, the Makefile's doc lints coverdocs/src, and[tool.yardang]lists the pages in order.docs/srcwith their links rewritten as relative paths. The template's install and contribute scaffold is replaced byhow-to/develop.md, written for this repo: the native extension, the kernel drivers andmake compile-unsignedfor the dext, the hardware-test switches, cibuildwheel and building the site.pip install dau-driver, where wheels exist, what a host with a board needs, and the device-permission trust model from the old Installation page) and a PyPI badge.test_docs.pyruns the two tutorials' Python blocks in order and checks every output they show; the how-to and reference pages are fragments for a real device. Fixing the one tutorial output that did not match: a blank line the code never prints.A language pass took out the em dashes, the all-caps emphasis and a few stock constructions across the pages. Facts corrected on the way:
read_status()returns link, MIG and operator-ready bits, and the transport-boundary page listed status bits among the layers; Read wire facts from dau-core and drop the undriven status bits #93 removed them.examples/link and an anchor link into the device reference did not resolve on the site; theScanBatchdocstring split an inline literal in its autoapi summary.yardang buildsucceeds with only yardang's ownautoapi_ignoredefault and the READMEs outside the toctree (kernel, scripts) as warnings.make lint,make checksand the suite pass (219 passed, 3 skipped).