Rust API (rustdoc)

docs.rs builds the API documentation of every Lamina PDF crate on crates.io. Start with laminapdf on docs.rs, the crate to depend on. It wraps the core crates and holds Document, Builder, Error, Warning, jobs and CancelToken.

The other crates are documented the same way:

• laminapdf-syntax
• laminapdf-cos
• laminapdf-model
• laminapdf-ops
• laminapdf-save
• laminapdf-content
• laminapdf-text
• laminapdf-build
• laminapdf-render-pdfium

docs.rs couldn’t build laminapdf-source and laminapdf-render at 0.2.0-alpha.2, so their docs come with the next release; until then, build them yourself as below. Install lists every crate, with its page on crates.io.

Build the docs yourself

To read the docs of a change before it’s released, build them from a checkout of Lamina PDF:

cargo doc --workspace --no-deps --all-features --open

The command opens the docs in your browser. Every public item of every crate is documented.