aws / s2n-tls

An implementation of the TLS/SSL protocols
https://aws.github.io/s2n-tls/usage-guide/
Apache License 2.0
4.51k stars 704 forks source link

Render docs with features enabled #4641

Open Mark-Simulacrum opened 2 months ago

Mark-Simulacrum commented 2 months ago

Problem:

docs.rs doesn't show the available functionality gated behind features (e.g. QUIC methods).

Solution:

We should leverage the docs.rs metadata (docs: https://docs.rs/about/metadata) to enable relevant features in the public documentation. Ideally, the cfg'd methods would also use doc(cfg(...)) (https://github.com/rust-lang/rust/issues/43781), so that the rendered docs make clear in a readable fashion what features need to be enabled. That feature is still unstable but docs.rs uses nightly compilers so that's not a problem.

Mark-Simulacrum commented 2 months ago

cc https://github.com/aws/s2n-quic/issues/1564, which is a related issue for s2n-quic