Check your cargo doc documentation for broken links!
Useful if you just refactored the structure of your crate or want to ensure that your documentation is readable offline.
Install cargo-deadlinks via:
cargo install cargo-deadlinksFrom your packages directory run:
# any broken links will show up in the output
cargo deadlinks
# if you also want to check http and https links
cargo deadlinks --check-httpBy default cargo deadlinks will check only the offline (file://) links of your package.
If you want to check the documentation in another directory e.g. to check all
your dependencies, you can provide the --dir argument:
cargo deadlinks --dir target/docFor information about other arguments run cargo deadlinks --help.
We are happy about any contributions!
To get started you can take a look at our Github issues.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as below, without any additional terms or conditions.
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.