Update READMEs, fix links (#7176)

* Re-generate READMEs to fix doc links; set readme field in package manifests

* Re-generate READMEs to fix doc links; set readme field in package manifests

* Re-generate READMEs to fix doc links; set readme field in package manifests

* Re-generate READMEs to fix doc links; set readme field in package manifests

* Revert stuff that shouldn't have been committed

* Revert stuff that shouldn't have been committed

* Fix parent relative link generation

* Manually remove this incorrect link for now.
This commit is contained in:
Steve Degosserie
2020-09-22 15:38:23 +02:00
committed by GitHub
parent f70ef87a0c
commit 22632efc5f
174 changed files with 319 additions and 121 deletions
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Collection of allocator implementations."
documentation = "https://docs.rs/sp-allocator"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Substrate runtime api primitives"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
documentation = "https://docs.rs/sp-application-crypto"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Minimal fixed point arithmetic primitives and types for runtime."
documentation = "https://docs.rs/sp-arithmetic"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "The block builder runtime api."
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Substrate blockchain traits and primitives."
documentation = "https://docs.rs/sp-blockchain"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Substrate chain configurations types."
readme = "README.md"
[dependencies]
serde = { version = "1.0.101", features = ["derive"] }
@@ -7,6 +7,7 @@ edition = "2018"
license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Common utilities for building and using consensus engines in substrate."
documentation = "https://docs.rs/sp-consensus/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ edition = "2018"
license = "Apache-2.0"
repository = "https://github.com/paritytech/substrate/"
homepage = "https://substrate.dev"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Substrate database trait."
documentation = "https://docs.rs/sp-database"
readme = "README.md"
[dependencies]
parking_lot = "0.10.0"
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Substrate externalities abstraction"
documentation = "https://docs.rs/sp-externalities"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Primitives for GRANDPA integration, suitable for WASM compilation."
documentation = "https://docs.rs/sp-finality-grandpa"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "FRAME module that tracks the last finalized block, as perceived by block authors."
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Provides types and traits for creating and checking inherents."
documentation = "https://docs.rs/sp-inherents"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "I/O for Substrate runtimes"
documentation = "https://docs.rs/sp-io"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Keyring support code for the runtime. A set of test accounts."
documentation = "https://docs.rs/sp-keyring"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "NPoS election algorithm primitives"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -7,6 +7,7 @@ authors = ["Parity Technologies <admin@parity.io>"]
edition = "2018"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Custom panic hook with bug report link"
documentation = "https://docs.rs/sp-panic-handler"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Substrate RPC primitives and utilities."
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Substrate runtime interface"
documentation = "https://docs.rs/sp-runtime-interface/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Runtime Modules shared primitive types."
documentation = "https://docs.rs/sp-runtime"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "This crate provides means to instantiate and execute wasm modules."
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Substrate customizable serde serializer."
documentation = "https://docs.rs/sp-serializer"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Primitives for sessions"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "A crate which contains primitives that are useful for implementation that uses staking approaches in general. Definitions related to sessions, slashing, etc go here."
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
documentation = "https://docs.rs/sp-state-machine"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -9,6 +9,7 @@ repository = "https://github.com/paritytech/substrate/"
description = "Lowest-abstraction level for the Substrate runtime: just exports useful primitives from std or client/alloc to be used with any code that depends on the runtime."
documentation = "https://docs.rs/sp-std"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -8,6 +8,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
documentation = "https://docs.rs/sp-storage/"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Substrate core types and inherents for timestamps."
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -7,6 +7,7 @@ edition = "2018"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Instrumentation primitives and macros for Substrate."
readme = "README.md"
[package.metadata.docs.rs]
# let's default to wasm32
+1 -1
View File
@@ -1,6 +1,6 @@
Substrate tracing primitives and macros.
To trace functions or invidual code in Substrate, this crate provides [`tracing_span`]
To trace functions or invidual code in Substrate, this crate provides [`within_span`]
and [`enter_span`]. See the individual docs for how to use these macros.
Note that to allow traces from wasm execution environment there are
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Transaction pool primitives types & Runtime API."
documentation = "https://docs.rs/sp-transaction-pool"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -8,6 +8,7 @@ license = "Apache-2.0"
edition = "2018"
homepage = "https://substrate.dev"
documentation = "https://docs.rs/sp-trie"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
+1
View File
@@ -7,6 +7,7 @@ license = "Apache-2.0"
homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "I/O for Substrate runtimes"
readme = "README.md"
[dependencies]
futures = "0.3.4"
+1
View File
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Version module for the Substrate runtime; Provides a function that returns the runtime version."
documentation = "https://docs.rs/sp-version"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]
@@ -8,6 +8,7 @@ homepage = "https://substrate.dev"
repository = "https://github.com/paritytech/substrate/"
description = "Types and traits for interfacing between the host and the wasm runtime."
documentation = "https://docs.rs/sp-wasm-interface"
readme = "README.md"
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu"]