docs: include modules behind feature flags#492
Open
landreussi wants to merge 3 commits into
Open
Conversation
Now `rustdoc` includes modules activated by feature flags in docs.rs.
landreussi
marked this pull request as ready for review
July 12, 2026 01:00
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This patch improves the way the documentation is generated by docs.rs; it wasn't showing modules included by feature flags.
Before this patch (https://docs.rs/boringtun):
After this patch (by running
cargo doc --all-features --no-deps):Also added a GHA job to check if docs.rs will generate docs successfully to this patch and future patches, and enforced rustdocs warnings as errors, but let me know if you guys don't like this, I think this is a nice-to-have only.