`cargo doc` によって生成されたドキュメントで機能要件タグを取得するにはどうすればよいでしょうか? 質問する

`cargo doc` によって生成されたドキュメントで機能要件タグを取得するにはどうすればよいでしょうか? 質問する

を見てみるとdocs.rs の Tokio ドキュメントこの API にアクセスするには機能を有効にする必要があることを示す青いタグがあります。

ここに画像の説明を入力してください

これを自分のクレートでも有効にしたいのですが、どうすればよいですか?

ベストアンサー1

残念なことに、これは今のところ夜間のみの機能です。

良いニュースは、docs.rs はデフォルトで nightly を使用することです。


これを機能させるには、doc_cfg特徴#doc(cfg)文書化されている項目に適用する

#![feature(doc_cfg)]

#[doc(cfg(feature = "macros"))]
pub fn test() {}

これは夜間のみの機能なので、常に有効にすることはおそらくないでしょう。docs.rsでのみこの機能を有効にするにtokioは、次のように定義します。Cargo.toml

# docs.rs-specific configuration
[package.metadata.docs.rs]
# document all features
all-features = true
# defines the configuration attribute `docsrs`
rustdoc-args = ["--cfg", "docsrs"]

そして彼らは

// only enables the `doc_cfg` feature when
// the `docsrs` configuration attribute is defined
#![cfg_attr(docsrs, feature(doc_cfg))]

#[cfg_attr(docsrs, doc(cfg(feature = "macros")))]
pub fn test() {}

おすすめ記事