Unverified Commit d821c7b8 authored by Niklas Adolfsson's avatar Niklas Adolfsson Committed by GitHub
Browse files

fix: generate docs for all features on docs.rs (#767)

* fix: generate docs for all features

* ci: check for --cfg docsrs

* fix nit: rustdoc::broken_intra_doc_links
parent 4fbf244d
Pipeline #193633 passed with stages
in 5 minutes and 1 second
......@@ -48,8 +48,22 @@ jobs:
command: clippy
args: --all-targets
- name: Check rustdoc links
run: RUSTDOCFLAGS="--deny broken_intra_doc_links" cargo doc --verbose --workspace --no-deps --document-private-items
check-docs:
name: Check rustdoc
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Rust nightly toolchain
uses: actions-rs/toolchain@v1.0.7
with:
profile: minimal
toolchain: nightly
override: true
- name: Check rustdoc
run: RUSTDOCFLAGS="--cfg docsrs --deny rustdoc::broken_intra_doc_links" cargo doc --verbose --workspace --no-deps --document-private-items --all-features
check-code:
name: Check
......
......@@ -29,3 +29,10 @@ tokio = { version = "1.16", features = ["net", "rt-multi-thread", "macros"] }
[features]
default = ["tls"]
tls = ["hyper-rustls/webpki-tokio"]
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[package.metadata.playground]
all-features = true
......@@ -54,3 +54,10 @@ web = [
"anyhow",
"thiserror",
]
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[package.metadata.playground]
all-features = true
......@@ -25,6 +25,7 @@
// DEALINGS IN THE SOFTWARE.
#![warn(missing_debug_implementations, missing_docs, unreachable_pub)]
#![cfg_attr(docsrs, feature(doc_cfg))]
//! # jsonrpsee-client-transports
//!
......
......@@ -23,3 +23,10 @@ serde_json = "1"
[features]
tls = ["jsonrpsee-client-transport/tls"]
default = ["tls"]
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[package.metadata.playground]
all-features = true
......@@ -68,3 +68,10 @@ async-wasm-client = [
serde_json = "1.0"
tokio = { version = "1.16", features = ["macros", "rt"] }
jsonrpsee = { path = "../jsonrpsee", features = ["server", "macros"] }
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[package.metadata.playground]
all-features = true
......@@ -27,6 +27,7 @@
//! Shared utilities for `jsonrpsee`.
#![warn(missing_docs, missing_debug_implementations, unreachable_pub)]
#![cfg_attr(docsrs, feature(doc_cfg))]
// Macros useful internally within this crate, but not to be exposed outside of it.
#[macro_use]
......
......@@ -37,3 +37,10 @@ macros = ["jsonrpsee-proc-macros", "jsonrpsee-types", "jsonrpsee-core/client", "
client = ["http-client", "ws-client", "wasm-client"]
server = ["http-server", "ws-server"]
full = ["client", "server", "macros", "async-client", "client-ws-transport"]
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[package.metadata.playground]
all-features = true
......@@ -48,6 +48,8 @@
//! - **`client-ws-transport`** - Enables `ws` transport with TLS.
//! - **`client-ws-transport-no-tls`** - Enables `ws` transport without TLS.
#![cfg_attr(docsrs, feature(doc_cfg))]
// Macros useful below, but not to be exposed outside of the crate.
#[macro_use]
mod macros;
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment