mbrobbel opened a new pull request, #7145:
URL: https://github.com/apache/arrow-rs/pull/7145
# 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](https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg)
and
[favicon](https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg))
and parquet ([logo/favicon](
https://raw.githubusercontent.com/apache/parquet-format/25f05e73d8cd7f5c83532ce51cb4f4de8ba5f2a2/logo/parquet-logos_1.svg))
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
