27 breaking releases
0.30.0 | Sep 13, 2024 |
---|---|
0.28.1 | Aug 1, 2024 |
0.28.0 | Jul 18, 2024 |
0.24.0 | Dec 24, 2023 |
0.1.0 |
|
#111 in Rust patterns
70,206 downloads per month
Used in 40 crates
(19 directly)
52KB
553 lines
Rustdoc Types
This crate contains the type definitions for rustdoc's currently-unstable
--output-format=json
flag. They can be deserialized with serde-json
from
the output of cargo +nightly rustdoc -- --output-format json -Z unstable-options
:
let json_string = std::fs::read_to_string("./target/doc/rustdoc_types.json")?;
let krate: rustdoc_types::Crate = serde_json::from_str(&json_string)?;
println!("the index has {} items", krate.index.len());
Contributing
This repo is a reexport of
rustdoc-json-types
from the rust repo. Any change to the contents of src/
, should be sent
to rust-lang/rust
, via their normal
contibution
procudures. Once
reviewed and merged there, the change will be pulled to this repo and published
to crates.io.
Release Procedure
- Run
./update.sh
to pull code from upstream - Run
cargo test
- Run
./clgen.sh <old_version> <new_version>
- Follow printed instructions to commit and push.
License
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.
Contribution
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 above, without any additional terms or conditions.
Dependencies
~0.4–1MB
~22K SLoC