Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build docs.rs documentation with all features enabled #21

Closed
joshlf opened this issue Sep 30, 2019 · 1 comment

Comments

@joshlf
Copy link
Member

commented Sep 30, 2019

Now that we're using docs.rs to host our documentation, we need to add metadata to the Cargo.toml file to instruct docs.rs to use all build features when building the documentation. By default, it just uses the default features, meaning that we get no documentation for things like the insecure feature.

For details on how to do this, see the "Metadata for custom builds" section here. In particular, we'll want a section like this:

[package.metadata.docs.rs]
features = [ "bytes", "insecure", "..." ]

In total, we'll want the following features documented:

  • bytes
  • insecure
  • kdf
  • rsa-pkcs1v15

We'll also want to add a comment on the [features] line in Cargo.toml reminding developers to update the [package.metadata.docs.rs] section when they update the [features] section.

@tsing80

This comment has been minimized.

@joshlf joshlf closed this in d510543 Oct 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.