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.

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

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

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

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

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
e3c8a6d
Use `doc_auto_cfg` for docs.rs and add logo and icon
mbrobbel Feb 17, 2025
1d5c179
Rustfmt
mbrobbel Feb 17, 2025
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
6 changes: 3 additions & 3 deletions arrow-arith/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ rust-version = { workspace = true }

[lib]
name = "arrow_arith"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
all-features = true

[dependencies]
arrow-array = { workspace = true }
arrow-buffer = { workspace = true }
arrow-data = { workspace = true }
arrow-schema = { workspace = true }
chrono = { workspace = true }
num = { version = "0.4", default-features = false, features = ["std"] }

[dev-dependencies]
5 changes: 5 additions & 0 deletions arrow-arith/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@

//! Arrow arithmetic and aggregation kernels

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]
pub mod aggregate;
#[doc(hidden)] // Kernels to be removed in a future release
Expand Down
7 changes: 3 additions & 4 deletions arrow-array/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,8 @@ rust-version = { workspace = true }

[lib]
name = "arrow_array"
path = "src/lib.rs"
bench = false


[target.'cfg(target_arch = "wasm32")'.dependencies]
ahash = { version = "0.8", default-features = false, features = ["compile-time-rng"] }

Expand All @@ -50,6 +48,9 @@ num = { version = "0.4.1", default-features = false, features = ["std"] }
half = { version = "2.1", default-features = false, features = ["num-traits"] }
hashbrown = { version = "0.15.1", default-features = false }

[package.metadata.docs.rs]
all-features = true

[features]
ffi = ["arrow-schema/ffi", "arrow-data/ffi"]
force_validate = []
Expand All @@ -58,8 +59,6 @@ force_validate = []
rand = { version = "0.8", default-features = false, features = ["std", "std_rng"] }
criterion = { version = "0.5", default-features = false }

[build-dependencies]

[[bench]]
name = "occupancy"
harness = false
Expand Down
5 changes: 5 additions & 0 deletions arrow-array/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,11 @@
//! [DataFusion]: https://github.com/apache/arrow-datafusion
//! [RecordBatchStream]: https://docs.rs/datafusion/latest/datafusion/execution/trait.RecordBatchStream.html

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![deny(rustdoc::broken_intra_doc_links)]
#![warn(missing_docs)]

Expand Down
6 changes: 3 additions & 3 deletions arrow-avro/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ rust-version = { workspace = true }

[lib]
name = "arrow_avro"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
all-features = true

[features]
default = ["deflate", "snappy", "zstd"]
deflate = ["flate2"]
Expand All @@ -49,7 +51,5 @@ snap = { version = "1.0", default-features = false, optional = true }
zstd = { version = "0.13", default-features = false, optional = true }
crc = { version = "3.0", optional = true }


[dev-dependencies]
rand = { version = "0.8", default-features = false, features = ["std", "std_rng"] }

5 changes: 5 additions & 0 deletions arrow-avro/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@
//! [Apache Arrow]: https://arrow.apache.org
//! [Apache Avro]: https://avro.apache.org/

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]
#![allow(unused)] // Temporary

Expand Down
6 changes: 3 additions & 3 deletions arrow-buffer/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ rust-version = { workspace = true }

[lib]
name = "arrow_buffer"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
all-features = true

[dependencies]
bytes = { version = "1.4" }
num = { version = "0.4", default-features = false, features = ["std"] }
Expand All @@ -42,8 +44,6 @@ half = { version = "2.1", default-features = false }
criterion = { version = "0.5", default-features = false }
rand = { version = "0.8", default-features = false, features = ["std", "std_rng"] }

[build-dependencies]

[[bench]]
name = "bit_mask"
harness = false
Expand Down
5 changes: 5 additions & 0 deletions arrow-buffer/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@

//! Low-level buffer abstractions for [Apache Arrow Rust](https://docs.rs/arrow)

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
// used by [`buffer::mutable::dangling_ptr`]
#![cfg_attr(miri, feature(strict_provenance))]
#![warn(missing_docs)]
Expand Down
5 changes: 1 addition & 4 deletions arrow-cast/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,10 @@ rust-version = { workspace = true }

[lib]
name = "arrow_cast"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
features = ["prettyprint"]
all-features = true

[features]
prettyprint = ["comfy-table"]
Expand All @@ -60,8 +59,6 @@ criterion = { version = "0.5", default-features = false }
half = { version = "2.1", default-features = false }
rand = "0.8"

[build-dependencies]

[[bench]]
name = "parse_timestamp"
harness = false
Expand Down
5 changes: 5 additions & 0 deletions arrow-cast/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@

//! Functions for converting from one data type to another in [Apache Arrow](https://docs.rs/arrow)

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]
pub mod cast;
pub use cast::*;
Expand Down
4 changes: 3 additions & 1 deletion arrow-csv/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ rust-version = { workspace = true }

[lib]
name = "arrow_csv"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
all-features = true

[dependencies]
arrow-array = { workspace = true }
arrow-cast = { workspace = true }
Expand Down
5 changes: 5 additions & 0 deletions arrow-csv/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@

//! Transfer data between the Arrow memory format and CSV (comma-separated values).

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]

pub mod reader;
Expand Down
3 changes: 1 addition & 2 deletions arrow-data/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ rust-version = { workspace = true }

[lib]
name = "arrow_data"
path = "src/lib.rs"
bench = false

[features]
Expand All @@ -42,7 +41,7 @@ force_validate = []
ffi = ["arrow-schema/ffi"]

[package.metadata.docs.rs]
features = ["ffi"]
all-features = true

[dependencies]

Expand Down
5 changes: 5 additions & 0 deletions arrow-data/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
//!
//! For a higher-level, strongly-typed interface see [arrow_array](https://docs.rs/arrow_array)

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]
mod data;
pub use data::*;
Expand Down
6 changes: 6 additions & 0 deletions arrow-flight/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@
//! `flight-sql-experimental` feature of this crate to be activated.
//!
//! [Flight SQL]: https://arrow.apache.org/docs/format/FlightSql.html

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![allow(rustdoc::invalid_html_tags)]
#![warn(missing_docs)]
// The unused_crate_dependencies lint does not work well for crates defining additional examples/bin targets
Expand Down
6 changes: 3 additions & 3 deletions arrow-integration-test/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ rust-version = { workspace = true }

[lib]
name = "arrow_integration_test"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
all-features = true

[dependencies]
arrow = { workspace = true }
arrow-buffer = { workspace = true }
hex = { version = "0.4", default-features = false, features = ["std"] }
serde = { version = "1.0", default-features = false, features = ["rc", "derive"] }
serde_json = { version = "1.0", default-features = false, features = ["std"] }
num = { version = "0.4", default-features = false, features = ["std"] }

[build-dependencies]
5 changes: 5 additions & 0 deletions arrow-integration-test/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@
//!
//! This is not a canonical format, but provides a human-readable way of verifying language implementations

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]
use arrow_buffer::{IntervalDayTime, IntervalMonthDayNano, ScalarBuffer};
use hex::decode;
Expand Down
4 changes: 3 additions & 1 deletion arrow-ipc/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ rust-version = { workspace = true }

[lib]
name = "arrow_ipc"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
all-features = true

[dependencies]
arrow-array = { workspace = true }
arrow-buffer = { workspace = true }
Expand Down
5 changes: 5 additions & 0 deletions arrow-ipc/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@
//! [FileReader]: reader::FileReader
//! [FileWriter]: writer::FileWriter

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]
pub mod convert;
pub mod reader;
Expand Down
5 changes: 3 additions & 2 deletions arrow-json/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ rust-version = { workspace = true }

[lib]
name = "arrow_json"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
all-features = true

[dependencies]
arrow-array = { workspace = true }
arrow-buffer = { workspace = true }
Expand All @@ -59,4 +61,3 @@ rand = { version = "0.8", default-features = false, features = ["std", "std_rng"
[[bench]]
name = "serde"
harness = false

5 changes: 5 additions & 0 deletions arrow-json/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,11 @@
//! [binary-to-text encoding]: https://en.wikipedia.org/wiki/Binary-to-text_encoding
//!

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![deny(rustdoc::broken_intra_doc_links)]
#![warn(missing_docs)]

Expand Down
4 changes: 3 additions & 1 deletion arrow-ord/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ rust-version = { workspace = true }

[lib]
name = "arrow_ord"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
all-features = true

[dependencies]
arrow-array = { workspace = true }
arrow-buffer = { workspace = true }
Expand Down
5 changes: 5 additions & 0 deletions arrow-ord/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@
//! ```
//!

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]
pub mod cmp;
#[doc(hidden)]
Expand Down
7 changes: 3 additions & 4 deletions arrow-row/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ rust-version = { workspace = true }

[lib]
name = "arrow_row"
path = "src/lib.rs"
bench = false

[package.metadata.docs.rs]
all-features = true

[dependencies]
arrow-array = { workspace = true }
arrow-buffer = { workspace = true }
Expand All @@ -45,6 +47,3 @@ half = { version = "2.1", default-features = false }
arrow-cast = { workspace = true }
arrow-ord = { workspace = true }
rand = { version = "0.8", default-features = false, features = ["std", "std_rng"] }

[features]

5 changes: 5 additions & 0 deletions arrow-row/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,11 @@
//! [compared]: PartialOrd
//! [compare]: PartialOrd

#![doc(
html_logo_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_white-bg.svg",
html_favicon_url = "https://arrow.apache.org/img/arrow-logo_chevrons_black-txt_transparent-bg.svg"
)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![warn(missing_docs)]
use std::cmp::Ordering;
use std::hash::{Hash, Hasher};
Expand Down
Loading
Loading