Expand description
Generates the site from the configuration and builds it.
StructsΒ§
- Dist
Category π - A group of dist artifacts sharing the same builder category.
- Dist
File πInfo - Metadata about a single file-type dist artifact, passed to Tera templates.
- Dist
Subgroup π - A sub-group of dist artifacts sharing the same group name (from the same builder entry).
- Version
Entry π - A version entry as passed to Tera templates.
ConstantsΒ§
- ATOM_
FEED_ πFILENAME - SITE_
CSS - SPINNER_
CHARS π - TEMPLATE_
BASE_ HTML - TEMPLATE_
ROOT_ INDEX_ GEMTEXT - TEMPLATE_
ROOT_ INDEX_ HTML - TEMPLATE_
VERSION_ INDEX_ GEMTEXT - TEMPLATE_
VERSION_ INDEX_ HTML
FunctionsΒ§
- build_
site - Build the full website into
config.output_dir(defaults topublic/). - compare_
versions π - copy_
dir_ πrecursive - Recursively copy the contents of
srcintodst. - find_
doc_ πcrates - Scan
docs_dirfor subdirectories that contain anindex.htmland return their names. Used to build a fallback listing when rustdoc itself did not generate a rootindex.html(typical for multi-crate workspaces). - generate_
atom_ πfeed - Generate an Atom 1.0 feed listing all known releases.
- hex_
sha256 π - Compute a lowercase hex-encoded SHA-256 digest of
data. - human_
size π - Format a byte count as a human-readable string (e.g. β1.4 MBβ).
- load_
extra_ πtheme_ templates - Scans
theme_pathfor any*.j2files whose stem (the name without the.j2suffix, e.g."base.html") is not already listed inskip, and loads each one intoteraunder that stem name. - register_
format_ πtemplates - Register templates for each configured output format, supporting theme overrides.
- spinner_
style π - Create a spinner style matching the rest of the abbaye UI.
When
indentis true the template is prefixed with two spaces (for child spinners). - strip_v π
- Compare two version strings, preferring semver ordering and falling back to lexicographic comparison for non-semver strings (e.g. git describe output).
- update_
latest_ πsymlink - Create or replace the
latestsymlink inoutput_dir, pointing toversion_dir_name. - write_
docs_ πindex - Write a
docs/index.htmlthat either redirects straight to the single crateβs docs (one crate) or lists all crates (multiple crates). - xml_
escape π - Escape the five XML predefined characters in a string.