rust-lightning/lightning-background-processor/Cargo.toml
Jeffrey Czyz 62b1e01ad9
Generate docs with features for docs.rs
Enable generating docs using --all-features or --features="std" where
applicable. Additionally, use doc_auto_cfg to tag items requiring a
feature.

https://doc.rust-lang.org/nightly/rustdoc/unstable-features.html#doc_auto_cfg-automatically-generate-doccfg

This requires building with nightly, which is what is used by docs.rs.

https://docs.rs/about/builds

To test locally, use:

RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc ...
2022-02-18 15:38:31 -06:00

23 lines
783 B
TOML

[package]
name = "lightning-background-processor"
version = "0.0.104"
authors = ["Valentine Wallace <vwallace@protonmail.com>"]
license = "MIT OR Apache-2.0"
repository = "http://github.com/lightningdevkit/rust-lightning"
description = """
Utilities to perform required background tasks for Rust Lightning.
"""
edition = "2018"
[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
[dependencies]
bitcoin = "0.27"
lightning = { version = "0.0.104", path = "../lightning", features = ["std"] }
lightning-persister = { version = "0.0.104", path = "../lightning-persister" }
[dev-dependencies]
lightning = { version = "0.0.104", path = "../lightning", features = ["_test_utils"] }
lightning-invoice = { version = "0.12.0", path = "../lightning-invoice" }