15 releases
0.1.14 | Nov 12, 2024 |
---|---|
0.1.13 | Oct 31, 2024 |
0.1.12 | Apr 6, 2024 |
0.1.10 | Feb 19, 2024 |
0.1.4 | Sep 30, 2023 |
#290 in Cargo plugins
194 downloads per month
22KB
465 lines
cargo docs-rs
Run cargo rustdoc
with the same options that would be used by docs.rs, taking
into account the package.metadata.docs.rs
configured in Cargo.toml.
Example
If the following GitHub Actions job succeeds, it's likely that docs.rs will succeed in building your crate's documentation.
# .github/workflows/ci.yml
name: test suite
on: [push, pull_request]
jobs:
# ...
doc:
name: Documentation
runs-on: ubuntu-latest
env:
RUSTDOCFLAGS: -Dwarnings
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@nightly
- uses: dtolnay/install@cargo-docs-rs
- run: cargo docs-rs
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~3–11MB
~117K SLoC