Expand description
Generates the site from the configuration and builds it.
StructsΒ§
- Dist
File πInfo - Metadata about a single file-type dist artifact, passed to Tera templates.
- Version
Entry π - A version entry as passed to Tera templates.
ConstantsΒ§
FunctionsΒ§
- archive_
dir π - Pack
srcdirectory into a.tar.gzarchive atdest. - build_
site - Build the full website into
config.output_dir(defaults topublic/). - compare_
versions π - copy_
dir_ πrecursive - Recursively copy the contents of
srcintodst. - extract_
local_ πrefs - Extract URLs of locally-referenced files from a Markdown document.
- 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β).
- render_
markdown π - Render Markdown to an HTML string.
- 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.