Skip to content

Specify Cargo features for the docs of the public APIs #8169

Open

Description

We've recently moved the docs of the public APIs of Zebra's crates to https://docs.rs. The zebrad crate has the features targetted for docs.rs specified in the [package.metadata.docs.rs] table. No other crates have this table specified in their Cargo.toml file. This seems to cause that, for example, the rendered docs for the zebra-rpc contain no documentation for the gbt-related RPCs, even though the getblocktemplate-rpcs feature enabled in the [package.metadata.docs.rs] table in zebrad/Cargo.toml.

Suggested Solution

For each crate, pick what features should be enabled, and list them in the [package.metada.docs.rs] table. It might be sufficient to enable the features listed in https://github.com/zcashfoundation/zebra/blob/b7e3158cd4b155d37a78e097e23a606ebaa40593/zebrad/Cargo.toml#L38.

Specification

https://docs.rs/about/metadata

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: DocumentationC-bugCategory: This is a bugI-usabilityZebra is hard to understand or use

    Type

    No type

    Projects

    • Status

      New

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions