module

CRDoc::Shards

Docs built locally from shards and kept as separate sources named shard:<name>.

Class methods

add(spec : String, log : IO) : Source

Builds and installs docs for spec: github:user/repo[@ref], gitlab:…, codeberg:…, a git URL (optionally @ref), or a local directory. Progress goes to log.

Source

add_from_lock(lock_file : Path, log : IO) : Array(Source)

Builds and installs docs for every shard in lock_file, using the checkouts under the sibling lib/ directory. Per-shard failures are logged and skipped, and an error is raised only when every shard fails.

Source

installed

Every installed shard source. Unreadable entries are skipped with a warning.

Source

refresh(name : String, log : IO) : Source

Rebuilds the source named name from its recorded origin.

Source

remove(name : String) : Bool

Removes the source named name. Returns false when it was not installed.

Source