Repository navigation
Releases
Doc42 0.8.1
Doc42 0.8.1
Doc42 now embeds the public document vocabulary, so packaged document generation works without a separate domain-library checkout.
- Embedded domain-library 0.6.0 through Spec42 0.60.2, alongside SysML standard library 2026-04.
- Expanded getting-started guide covering an authored document, a model-backed table and template customization.
- Packaged examples validated on Linux and Windows without external document-library paths, including byte-identical PDFs on repeated builds.
Upgrade from 0.8.0
Remove the old domain-library checkout and its --library-path argument. Keep paths for additional project libraries. Loading a second copy of the embedded vocabulary can make names ambiguous. Use domain-library 0.6.0 in your editor.
Downloads
Download the archive for your platform and SHA256SUMS.txt, verify the checksum and extract it. Linux x64 requires glibc 2.35 or later; Windows x64 includes the C runtime statically. The compiler, fonts and model libraries are embedded. The archives include the first-document example.
doc42 list and doc42 check need no account. PDF generation and IR export require Doc42 access and an Elan8 API token through doc42 login or the ELAN8_TOKEN environment variable. Models and documents stay local.
The attached sample PDFs demonstrate the first document, drone SRS and four-document temperature-monitor suite. The verification report contains authored content, not executed evidence or an automatic verdict.
Doc42 0.8.0
Doc42 0.8.0
Doc42 0.8.0 connects to your Elan8 account with an API token. An active trial or subscription with Doc42 access lets you generate engineering PDFs and export document IR.
- Build one document or all document PDFs with
doc42 build, or export document IR withdoc42 ir, using an Elan8 API token. - Display recorded run verdicts from JSON in tables; missing records are shown as
not run. - List and check documents and manage templates without a license.
- Sign in locally with
doc42 login, or use theELAN8_TOKENsecret in CI. Signed licenses refresh after 24 hours; a verified cached license remains usable until its signed expiry, at most 48 hours after issuance.
This is the current supported documentation and installation baseline. See installation, your first PDF, and automation.
Download the Linux x64 archive (glibc 2.35 or later) or Windows x64 ZIP and verify it against SHA256SUMS.txt. Both packages include licenses and a first-document example. Sample PDFs are attached separately. The embedded Spec42 engine is 0.60.1; the example domain-library revision is 4c73195b2f64176696b2e0f4d72606bfd044dcef.
Doc42 0.7.0
Doc42 0.7.0
Doc42 now uses an Elan8 API token for local sign-in and CI document generation.
doc42 loginreads a token with hidden input and saves it for the Elan8 tools.- CI uses
ELAN8_TOKEN. The client obtains and refreshes a signed license, verifies it locally, and supports cached offline use until the license expires. doc42 logoutremoves the saved token and cached licenses;doc42 licensereports their status without printing credentials.- The archives include a small
examples/first-documentquickstart. Both packaged executables are tested against real documents, including repeated builds with identical PDF bytes. - Versioned documentation preserves the 0.6 instructions alongside the new authentication, migration, CLI, and troubleshooting guides.
- Sample PDFs for the first document, drone requirements, and four-document monitor suite are attached to this release.
Upgrade from 0.6
ELAN8_LICENSE is retired. Create an API token on your Elan8 account, then run doc42 login locally or pass the token as the ELAN8_TOKEN CI secret. Existing signed license strings are not API tokens.
Compatibility
- Embedded Spec42: 0.60.1
- SysML standard library: 2026-04
- Document vocabulary: sysml-domain-libraries at 146fe5ca70e76d8692e96f4a666e974592c40abc
- Linux x64: glibc 2.35 or newer
- Windows x64: no additional Visual C++ runtime required
Verify the downloaded archives against SHA256SUMS.txt before extracting them.
GitHub Actions
- uses: elan8/doc42-release@v0.7.0
- run: doc42 build model --all --library-path .libraries/sysml-domain-libraries/model --out generated
env:
ELAN8_TOKEN: ${{ secrets.ELAN8_TOKEN }}See the 0.7 documentation and first-document example.
Doc42 0.6.0
Doc42 builds every document of a model in one run, keeps readable diagrams in the text, and warns when a figure would print too small to read.
- Build every document at once.
doc42 build model --all --out outbuilds all documents in the model, loading it once. Every document is checked before any is rendered, so an error leaves no partial set. With--json,buildprints a manifest of the files written and each document's metadata (title, number, revision, status, …);doc42 list --jsonreports the same metadata without a license. - Diagrams stay in the text when they can. A diagram that stays readable when scaled to the text width (65 % or more) stays in the text on the portrait page, scaled to fit, instead of running past the margin. Only a larger one gets a page of its own, landscape when that shows it clearly larger.
- Too-small figures are reported. When a figure's smallest text would print below 5 pt,
check,buildandirwarn withdoc42-figure-text-size, naming the printed size and the page. Set another minimum with--min-text-size, and make it an error with--strict, so a release job stops on an unreadable figure. - Clearer diagrams from Spec42 0.60.1. Action flows put inputs on top of each action and outputs below it, so flows run straight down. In interconnection views limited in depth, a bus is drawn as one port and ports face the parts they connect to. Diagrams whose expressions use quantity units, such as
remaining + 60 [s]in a transition, no longer stop the build. doc42.exeneeds nothing beyond Windows. It is built natively for Windows and needs no Visual C++ redistributable.
Breaking: the Document IR (doc42 ir) is version 4. Figures add placement and smallest_text. A custom template that places figures itself should use placement; templates that use the built-in doc42-figure need no change.
Use elan8/doc42-release@v0.6.0. Built with Spec42 0.60.1. Linux x64 needs glibc 2.35 or later.
Doc42 0.5.0
Doc42 now runs on Windows, reads its document metadata from the Elan8 domain libraries, and lets a document limit how deep its diagrams go.
- Windows x64.
doc42-0.5.0-windows-x64.zipholdsdoc42.exe, for local use. The GitHub Action still installs on Linux x64 runners. - Document metadata from
Elan8::Documents. Documents use@Elan8::Documents::Document,@Section,@Tableand the rest fromsysml-domain-librariesinstead of the formerDoc42library. Pass itsmodeldirectory with--library-path. Replaceprivate import Doc42::*;withprivate import Elan8::Documents::*;.doc42 library exportis gone;doc42 template exportwrites a built-in template. - Diagram depth.
@Diagram { depth = n; }on a diagram section drawsnlevels of parts below the exposed elements and the deeper ones closed, so an overview of a whole product stays readable on a page. - Names in prose resolve through imports and aliases.
{{= Aliases::mass}}and{{Architecture::Module::latency}}now find elements reached through public imports, aliases and inherited members. satisfy requirement r : R by xis listed underRin traceability tables.- Stricter model checks from Spec42 0.59.2. For example: imports need a visibility, and a value may only override a default.
This repository was called doc42-action. Use elan8/doc42-release@v0.5.0; old links redirect.
Built with Spec42 0.59.2. Linux x64 needs glibc 2.35 or later.
Doc42 0.4.0
All styling of generated content is now in the template, and tables can show verification planning.
- Theme. The colours of generated tables, quotes and code blocks are a theme a template sets with
doc42-theme.update(...), so a house template controls the whole look of a document. verifiescolumn. For a verification case: the requirements its objective verifies.- Related columns.
relation / contentshows a property of the elements a relation names, each distinct value once:verified-by / @VerificationMethod.kindlists the methods that verify a requirement,derived-from / idthe identifiers of its parents. - A table column of several lines is sized by its longest line.
Use elan8/doc42-action@v0.4.0. Linux x64 only (glibc 2.35 or later). Built with Spec42 0.54.1.
Doc42 0.3.0
Documents read more from the model, and the layout can be your own.
- Tables from the model.
@Tablepresents 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-templatewrites a built-in template as a starting point; select it withtemplate = "my-template"in@Documentor with--template. - Markdown in
doccomments. Headings, block quotes and fenced code blocks now render, indoccomments 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.
Doc42 0.2.0
Documents can now carry content that the model does not draw or tabulate by itself.
- Authored figures.
@Figure { file = "figures/layout.svg"; caption = "Product layout"; }places an SVG drawing after a section's prose, numbered and captioned like a generated diagram. - Markdown tables. A table in a prose file becomes a table in the document. Use it for content generated outside Doc42, such as a bill of materials or a verification matrix. A right-aligned column (
---:) is set as numbers; short columns take their content width and columns of running text share the rest. - A section can include several prose files, in the order they are written.
Use elan8/doc42-action@v0.2.0. Linux x64 only (glibc 2.35 or later). Built with Spec42 0.54.1.
Doc42 0.1.1
Fixes the layout of requirement tables: the text and satisfied-by columns keep proportional widths, long qualified names wrap, and a table continues on the next page with its header repeated. In 0.1.0 a filled "Satisfied by" column squeezed the text column and rows could overlap at the end of a page.
Use elan8/doc42-action@v0.1.1. Linux x64 only (glibc 2.35 or later). Built with Spec42 0.54.1.
Doc42 0.1.0
Superseded by 0.1.1, which fixes the layout of requirement tables. Use 0.1.1.
First release of Doc42, which generates engineering documents as PDF from a SysML v2 repository. Linux x64 only (glibc 2.35 or later). Built with Spec42 0.54.1.