Skip to content

Doc42 0.3.0

Choose a tag to compare

@jevontech jevontech released this 11 Oct 08:08
· 26 commits to main since this release

Documents read more from the model, and the layout can be your own.

  • Tables from the model. @Table presents the elements a section exposes, with the columns you name: identifier, name, text, type, satisfied by, verified by, derived from, feature values (.mass) and metadata values (@Rationale.text). expose Package::* gives one row for each member, so a requirement table, a traceability table or a verification matrix no longer needs a script.
  • Values in text. {{= DesignLimits::maxRobotMass}} shows the value of a feature with its unit, so a number in the text cannot disagree with the model. A feature without a constant value is an error.
  • Your own template. A template is a directory with a main.typ, its own files and fonts. doc42 template export srs my-template writes a built-in template as a starting point; select it with template = "my-template" in @Document or with --template.
  • Markdown in doc comments. Headings, block quotes and fenced code blocks now render, in doc comments and prose files alike.
  • Table columns are sized so that a long unbreakable name fits.

Values are the ones Spec42 evaluates: literals and arithmetic over plain numbers today. Sums of quantities, sum(...) and units written as an expression ([m^2]) are not evaluated yet.

Use elan8/doc42-action@v0.3.0. Linux x64 only (glibc 2.35 or later). Built with Spec42 0.54.1.