#cargo #subcommand #documentation #docs-rs

app cargo-docs-rs

Imitate the documentation build that docs.rs would do

11 releases

0.1.10 Feb 19, 2024
0.1.9 Feb 10, 2024
0.1.8 Jan 13, 2024
0.1.6 Dec 9, 2023
0.1.4 Sep 30, 2023

#236 in Cargo plugins

Download history 33/week @ 2023-11-12 15/week @ 2023-11-19 38/week @ 2023-11-26 27/week @ 2023-12-03 47/week @ 2023-12-10 24/week @ 2023-12-17 17/week @ 2023-12-24 47/week @ 2023-12-31 28/week @ 2024-01-07 24/week @ 2024-01-14 9/week @ 2024-01-21 40/week @ 2024-01-28 26/week @ 2024-02-04 61/week @ 2024-02-11 433/week @ 2024-02-18

561 downloads per month

MIT/Apache

18KB
370 lines

cargo docs-rs

github crates.io build status

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

~2–2.8MB
~57K SLoC