Skip to content

Simplify docs.rs documentation and build whole API #181

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.

Sign up for GitHub

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

Open
hannobraun wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Simplify docs.rs documentation and build whole API #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a36f7f0
Remove unused `docs.rs` configuration
hannobraun Jan 7, 2026
9ee4878
Enable all features when building documentation
hannobraun Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions crates/cobs-acc/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ keywords = []
documentation = "https://docs.rs/cobs-acc/"

[package.metadata.docs.rs]
rustdoc-args = ["--cfg", "docsrs"]

@jamesmunns jamesmunns Jan 7, 2026

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is used for gating some kind of docs-rs feature display

Screenshot 2026-01-07 at 15 23 11

and https://github.com/jamesmunns/postcard/blob/bee7f0f965362e4ac687a2721d81f916e78735b1/source/postcard/src/lib.rs#L75-L106 are examples

I don't entirely recall how this works though, I probably copy and pasted it from postcard or similar.

Tho looking at https://github.com/jamesmunns/postcard/pull/108/files, we might be missing the second half of this, e.g. #[cfg_attr(doc_cfg, doc(cfg(feature = "alloc")))]. I'd prefer to keep this in and actually go fix the other missing half.

@hannobraun hannobraun Jan 7, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, okay, I didn't consider that it actually should be used. I just saw that it isn't, and figured its some copy/paste remnant 😅

I'll look into this! But first, I'd like to dump some research here, so there's a more complete picture for later reference.

features = ["std"]
all-features = true

[dependencies]
cobs = { version = "0.4.0", default-features = false }
Expand Down
3 changes: 1 addition & 2 deletions crates/ergot/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ keywords = []
documentation = "https://docs.rs/ergot/"

[package.metadata.docs.rs]
rustdoc-args = ["--cfg", "docsrs"]
features = ["tokio-std"]
all-features = true

[features]
default = [
Expand Down