Repository navigation
docs: documenting your schemas with comline doc - #111
Merged
Merged
Conversation
A Guide page, the `comline doc` reference row and page, comline.toml's `[doc]` keys, `Render` in the generator protocol, and the documentation model's JSON Schema served at `schemas/doc-model/1.json` with a drift check beside the comline.toml schema's. The comline.toml schema copy is refreshed for `[doc]`. Module docs are now stored with each build, so the docstrings page says so.
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.
Part of ComlineProject/core#145, step 7 of the autodoc cascade. Not closing it: rendering
stdonto this site (the issue's proof of the Markdown renderer) is the next step, and hiding a unit is still to be confirmed.guide/documenting.md): writing///and//!docs,comline doc, putting the pages on a mkdocs/zensical site, dependency links, documenting a built version, the JSON model, external renderers, the settings table, and std rendering as what's next.comline docrow inreference/cli.mdand a page,reference/tools/doc.md(in the nav under Tools).[doc]keys (out,format,renderer,timeout,links,changelog_from).Renderrequest,Response::Render,Description.renderers, the renderer check, and the rule for whenPROTOCOL_VERSIONmoves (an additive change keeps it).schemas/doc-model.jsonserved atschemas/doc-model/1.json(its$id).scripts/sync-comline-toml-schema.pynow checks both copies (--core-revpins core's), and the Schema drift workflow says so.schemas/comline-toml/0.x.jsonrefreshed from generation7b51264.Merge order: after ComlineProject/generation#95, or the schema drift check fails (it compares the comline.toml copy with generation's
HEAD, which doesn't have[doc]yet; the doc-model copy already matches core'smaster). The CLI drift check needs ComlineProject/cli#111 merged first, as usual.Local:
zensical build --strict(no issues), no unrendered template syntax,check-cli-drift.pyagainst the cli#111 binary (no drift), schema sync against the pinned revs.