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

Use doc_auto_cfg, logo and favicon for docs.rs #7145

Merged
merged 3 commits into from
Mar 8, 2025

Conversation

mbrobbel
Copy link
Contributor

Which issue does this PR close?

None.

Rationale for this change

  1. Make it easier to discover required features for items in the arrow, parquet and object_store crates on docs.rs.
  2. Add logos and favicon for arrow and parquet crates on docs.rs.

What changes are included in this PR?

  • #![cfg_attr(docsrs, feature(doc_auto_cfg))] for all published crates (also the ones without features, to make this work when features are added in the feature).
  • Set all-features = true in [package.metadata.docs.rs] for those crates to get docs for all items.
  • Add logos for arrow (logo and favicon) and parquet (logo/favicon) on docs.rs.
  • Removed src/lib.rs from [lib] sections (this is the default value), and removed some empty [*-dependencies] sections in Cargo.toml files.

To test this locally (requires nightly rust + cargo-docs-rs):

rustup toolchain install nightly
cargo install --locked cargo-docs-rs
cargo +nightly docs-rs -p <crate>

Are there any user-facing changes?

Users will now see required features on docs.rs.

@github-actions github-actions bot added parquet Changes to the parquet crate arrow Changes to the arrow crate arrow-flight Changes to the arrow-flight crate object-store Object Store Interface parquet-derive labels Feb 17, 2025
Copy link
Contributor

@alamb alamb left a comment

Choose a reason for hiding this comment

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

Thank you so much @mbrobbel -- this is super useful

I tested this PR out locally and it looks really nice

Screenshot 2025-03-07 at 7 25 52 AM
Screenshot 2025-03-07 at 7 26 36 AM
Screenshot 2025-03-07 at 7 27 08 AM
Screenshot 2025-03-07 at 7 27 31 AM

@alamb alamb added the documentation Improvements or additions to documentation label Mar 7, 2025
@tustvold tustvold merged commit ffd490f into apache:main Mar 8, 2025
34 checks passed
@mbrobbel mbrobbel deleted the doc_auto_cfg branch March 10, 2025 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrow Changes to the arrow crate arrow-flight Changes to the arrow-flight crate documentation Improvements or additions to documentation object-store Object Store Interface parquet Changes to the parquet crate parquet-derive
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants