Update crate name and add README
This commit is contained in:
parent
3076e255fe
commit
67b78a0271
6 changed files with 24 additions and 12 deletions
16
Cargo.lock
16
Cargo.lock
|
@ -1637,13 +1637,6 @@ version = "0.11.15"
|
||||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||||
checksum = "92c245af8786f6ac35f95ca14feca9119e71339aaab41e878e7cdd655c97e9e5"
|
checksum = "92c245af8786f6ac35f95ca14feca9119e71339aaab41e878e7cdd655c97e9e5"
|
||||||
|
|
||||||
[[package]]
|
|
||||||
name = "json-types"
|
|
||||||
version = "0.1.0"
|
|
||||||
dependencies = [
|
|
||||||
"serde",
|
|
||||||
]
|
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "jsondocck"
|
name = "jsondocck"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
|
@ -4393,17 +4386,24 @@ version = "0.0.0"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"expect-test",
|
"expect-test",
|
||||||
"itertools 0.9.0",
|
"itertools 0.9.0",
|
||||||
"json-types",
|
|
||||||
"minifier",
|
"minifier",
|
||||||
"pulldown-cmark 0.8.0",
|
"pulldown-cmark 0.8.0",
|
||||||
"regex",
|
"regex",
|
||||||
"rustc-rayon",
|
"rustc-rayon",
|
||||||
|
"rustdoc-json-types",
|
||||||
"serde",
|
"serde",
|
||||||
"serde_json",
|
"serde_json",
|
||||||
"smallvec 1.4.2",
|
"smallvec 1.4.2",
|
||||||
"tempfile",
|
"tempfile",
|
||||||
]
|
]
|
||||||
|
|
||||||
|
[[package]]
|
||||||
|
name = "rustdoc-json-types"
|
||||||
|
version = "0.1.0"
|
||||||
|
dependencies = [
|
||||||
|
"serde",
|
||||||
|
]
|
||||||
|
|
||||||
[[package]]
|
[[package]]
|
||||||
name = "rustdoc-themes"
|
name = "rustdoc-themes"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
|
|
|
@ -17,7 +17,7 @@ smallvec = "1.0"
|
||||||
tempfile = "3"
|
tempfile = "3"
|
||||||
itertools = "0.9"
|
itertools = "0.9"
|
||||||
regex = "1"
|
regex = "1"
|
||||||
json-types = { path = "../rustdoc-json-types" }
|
rustdoc-json-types = { path = "../rustdoc-json-types" }
|
||||||
|
|
||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
expect-test = "1.0"
|
expect-test = "1.0"
|
||||||
|
|
|
@ -9,7 +9,7 @@ use rustc_hir::def::CtorKind;
|
||||||
use rustc_span::def_id::{DefId, CRATE_DEF_INDEX};
|
use rustc_span::def_id::{DefId, CRATE_DEF_INDEX};
|
||||||
use rustc_span::Pos;
|
use rustc_span::Pos;
|
||||||
|
|
||||||
use json_types::*;
|
use rustdoc_json_types::*;
|
||||||
|
|
||||||
use crate::clean;
|
use crate::clean;
|
||||||
use crate::formats::item_type::ItemType;
|
use crate::formats::item_type::ItemType;
|
||||||
|
|
|
@ -16,7 +16,7 @@ use rustc_middle::ty::TyCtxt;
|
||||||
use rustc_session::Session;
|
use rustc_session::Session;
|
||||||
use rustc_span::edition::Edition;
|
use rustc_span::edition::Edition;
|
||||||
|
|
||||||
use json_types as types;
|
use rustdoc_json_types as types;
|
||||||
|
|
||||||
use crate::clean;
|
use crate::clean;
|
||||||
use crate::config::{RenderInfo, RenderOptions};
|
use crate::config::{RenderInfo, RenderOptions};
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
[package]
|
[package]
|
||||||
name = "json-types"
|
name = "rustdoc-json-types"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
authors = ["The Rust Project Developers"]
|
authors = ["The Rust Project Developers"]
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
|
|
12
src/rustdoc-json-types/README.md
Normal file
12
src/rustdoc-json-types/README.md
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
# Rustdoc JSON Types
|
||||||
|
|
||||||
|
This crate exposes the Rustdoc JSON API as a set of types with serde implementations.
|
||||||
|
These types are part of the public interface of the rustdoc JSON output, and making them
|
||||||
|
their own crate allows them to be versioned and distributed without having to depend on
|
||||||
|
any rustc/rustdoc internals. This way, consumers can rely on this crate for both documentation
|
||||||
|
of the output, and as a way to read the output easily, and its versioning is intended to
|
||||||
|
follow semver guarantees about the version of the format. JSON format X will always be
|
||||||
|
compatible with rustdoc-json-types version N.
|
||||||
|
|
||||||
|
Currently, this crate is only used by rustdoc itself. Upon the stabilization of
|
||||||
|
rustdoc-json, it may be start to be distributed separately for consumers of the API.
|
Loading…
Add table
Reference in a new issue