1
0
Fork 0
mirror of https://github.com/actix/actix-web.git synced 2024-11-22 09:31:10 +00:00

docs: local docs doc everything but only list workspace crates

This commit is contained in:
Rob Ede 2024-06-10 23:30:51 +01:00
parent 4c4c279938
commit cd301a6932
No known key found for this signature in database
GPG key ID: 97C636207D3EF933

View file

@ -68,8 +68,17 @@ test-coverage-lcov toolchain="": (test-coverage toolchain)
cargo {{ toolchain }} llvm-cov report --doctests --lcov --output-path=lcov.info
# Document crates in workspace.
doc *args:
RUSTDOCFLAGS="--cfg=docsrs -Dwarnings" cargo +nightly doc --no-deps --workspace {{ all_crate_features }} {{ args }}
doc *args: && doc-set-workspace-crates
RUSTDOCFLAGS="--cfg=docsrs -Dwarnings" cargo +nightly doc --workspace {{ all_crate_features }} {{ args }}
[private]
doc-set-workspace-crates:
#!/usr/bin/env bash
(
echo "window.ALL_CRATES ="
cargo metadata --format-version=1 | jq '[.packages[] | select(.source == null) | .name]'
echo ";"
) > "$CARGO_TARGET_DIR/doc/crates.js"
# Document crates in workspace and watch for changes.
doc-watch: