Skip to main content

site_links_page_relative

Function site_links_page_relative 

fn site_links_page_relative(doc: &dyn GeneratedDoc) -> Result<String, Error>
Expand description

Renders one generator’s output, with this site’s own absolute URLs made page-relative.

Applied here rather than in each generator, for the reason markdown::site_links_page_relative exists at all: the rule is a property of the page being written, and every generator that inlines doc-comment or clap prose is subject to it — catalog, cli, errors, environment, journal and space-dsl all carry such a citation today. One call site cannot be forgotten by the tenth generator; six can. It also means the rule holds for --mode dry-run, so the printed output is the bytes that would be written.

A Framing::WholeFile output outside docs/ is exempt, and the three Python stubs under crates/atune_py/python/atune/ are read by tooling with no notion of a page, so their citations stay absolute. docs/api_links.yml is under docs/ but is not a page and spells no site URL — it carries the templates the resolver applies (D38 sub-decision 2).