Repository navigation
doc: --format html, the official HTML renderer linked in - #112
Merged
Merged
Conversation
comline doc --format html (or [doc] format = "html") writes a self-contained static site with generation's comline-doc-html: index.html, a page per module, changelog.html, style.css and search.js. - Re-pins generation to 58ff61b (generation#98) for comline-codegen, comline-doc-markdown and the new comline-doc-html, and comline-rust and comline-typescript to their bumps onto it (comline-rust#87, comline-typescript#103), so the graph keeps one comline-codegen. - Tests: an HTML site for the working tree, format = "html" in comline.toml, an unknown format naming both renderers, and the HTML renderer run as an external .wasm and native renderer writing the built-in's output byte for byte. - docs/cli.md and the doc command's help cover html.
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.
Links generation's
comline-doc-html(ComlineProject/generation#98) intocomline doc:--format htmlor[doc] format = "html"writes a self-contained static site (index.html, a page per module,changelog.html,style.css,search.js).Re-pins. generation moves
7b51264→58ff61b(generation#98's tip) forcomline-codegen,comline-doc-markdownand the newcomline-doc-html. comline-rust moves to52e0ead(comline-rust#87) and comline-typescript to932edaa(comline-typescript#103), both bumped onto that rev, so the graph keeps onecomline-codegen. The test fixtures' generators crate moves with them. language-server and playground don't link the HTML renderer, and their own graphs are consistent at the old revs, so they stay.Byte-identical generated code.
comline generate --mode codeand--mode lib, pluscomline doc(Markdown), on every cli fixture (simple_project,chat_project,validated_project,conformance_package), give identical trees (diff -r) between amainbinary and this branch's.Tests:
tests/cli/doc.rs: an HTML site for the working tree with a changelog,format = "html"in comline.toml, and an unknown format naming both renderers.tests/cli/external.rs: the HTML renderer run as an external.wasmand as a native renderer writes the built-in's output byte for byte. A new fixture bin,renderer-html, is generation'scomline-doc-htmlbinary.docs/cli.mdandcomline doc --helpcoverhtml.Merge order: generation#98, then comline-rust#87 and comline-typescript#103, then this PR, then docs#113.