API rustdoc
Every public item is documented. CI builds rustdoc with
RUSTDOCFLAGS='-D warnings' and publishes it next to this site.
Crate rustdoc: siderite API (generated on deploy).
Until crates.io publishes the first release, this hosted rustdoc is the API reference. After publish, docs.rs will carry the same docs per version.
| Crate | rustdoc |
|---|---|
siderite |
/api/siderite/ |
siderite-core |
/api/siderite_core/ |
siderite-validation |
/api/siderite_validation/ |
siderite-orm |
/api/siderite_orm/ |
siderite-backends |
/api/siderite_backends/ |
siderite-macros |
/api/siderite_macros/ |
siderite-openapi |
/api/siderite_openapi/ |
siderite-migrations |
/api/siderite_migrations/ |
siderite-config |
/api/siderite_config/ |
siderite-cache |
/api/siderite_cache/ |
siderite-sessions |
/api/siderite_sessions/ |
siderite-cli |
/api/siderite_cli/ |
siderite-testkit |
/api/siderite_testkit/ |
Build it locally:
cargo doc --workspace --no-deps --all-features --openOn this GitHub Pages site the same output is copied to /api/ after the
Starlight build. The rustdoc pages are not in the Starlight sidebar; they
use rustdoc’s own navigation.