Skip to main content

Crate nova_doc

Crate nova_doc 

Source
Expand description

nova doc: the documentation site (spec docs/superpowers/specs/2026-10-11-phase-3-5a-the-documentation-site-design.md; ADR 0034).

Structs§

BrokenLink
A link that leads nowhere: the page it is on, from the site’s root, and the link as written.
CodeBlock
A code block, and where its lines are in the Markdown.
CodeLine
A line of a code block.
DocTest
A doc test: one Nova code block of the docs a library’s site shows, as a test module (spec §5).
Documented
A program documented: its site, and the warnings its analysis found, with the files they point into.
Site
A site: its packages, std last (spec §6.1).

Enums§

Block
What a code block is (3.5b spec §4.2).
Failure
Why a program was not documented.
Origin
Where a line of a doc test’s text comes from (spec §7).
WriteError
Why a site was not written.

Constants§

MARKER
The file every site holds, so that nova doc replaces only a directory it wrote (spec §4.3).

Functions§

check_links
Every link in the site at dir that is not absolute and leads to no file of the site, or to no id on its page (spec §11). Pages in order of their paths, and each page’s links in order.
classify
The block whose info string is info, or an indented block for None (3.5b spec §4.2). The info string is split at commas and whitespace into words, and empty words are dropped.
code_blocks
Every code block of the Markdown text, as the site finds them.
document_package
Document the package whose nova.toml is in root (empty for the current directory), its dependencies and std (spec §5.1).
document_std
Document std alone (spec §4.1, --std).
hidden
For a hidden line of a Nova block (3.5b spec §4.3), where its # , or its lone #, starts and how many bytes it is; None for a line that shows. It runs less that mark.
hide_lines
markdown with the hidden lines of its Nova blocks left out (3.5b spec §8.2), every other byte as it was. Hover shows docs through it.
package_doc_tests
The doc tests of the package whose nova.toml is in root (spec §4.1), in the site’s order; None when it has no library.
std_doc_tests
std’s doc tests (spec §6.1, --std), in the site’s order.
write_site
Write site to dir, replacing a site written there before (spec §4.3). Returns the start page’s path.