Skip to main content

Module doc_render

Module doc_render 

Source
Expand description

v0.110: static HTML site generator for a frontier.

Self-contained: no JS framework, no external dependencies, no build step. vela doc <path> writes a small set of HTML files plus a single CSS file to an output directory; the result is browseable from disk in any browser. Cargo’s docs.rs analog for scientific state.

Output structure:

<out>/
  index.html          frontier overview
  findings.html       table of every finding
  findings/<vf_id>.html   per-finding detail pages
  events.html         table of every canonical event
  style.css           minimal styling

No DSL, no dynamic rendering. Plain HTML written by format!.

Structs§

DocReport
Result returned to the CLI: counts and the output root path.

Functions§

write_site
Write the static documentation site for project into out_dir. Creates the directory tree if absent.