Merge pull request #1142 from waywardmonkeys/enable-all-features-and-…

…doc_auto_cfg-on-docs-rs Generate docs for most features on docs.rs
googlefonts · Sep 11, 2024 · 7b4d9ba · 7b4d9ba
2 parents 5780ca0 + cd89d23
commit 7b4d9ba
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 0 deletions.
diff --git a/font-types/Cargo.toml b/font-types/Cargo.toml
@@ -9,6 +9,11 @@ edition.workspace = true
 license.workspace = true
 repository.workspace = true
 
+[package.metadata.docs.rs]
+# To build locally:
+# RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+all-features = true
+
 [features]
 std = []
 bytemuck = ["dep:bytemuck"]

diff --git a/font-types/src/lib.rs b/font-types/src/lib.rs
@@ -2,6 +2,7 @@
 //!
 //! [data types]: https://docs.microsoft.com/en-us/typography/opentype/spec/otff#data-types
 
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![deny(rustdoc::broken_intra_doc_links)]
 #![warn(clippy::doc_markdown)]
 #![cfg_attr(not(feature = "std"), no_std)]

diff --git a/read-fonts/Cargo.toml b/read-fonts/Cargo.toml
@@ -9,6 +9,11 @@ edition.workspace = true
 license.workspace = true
 repository.workspace = true
 
+[package.metadata.docs.rs]
+# To build locally:
+# RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --features libm,serde,std
+features = ["libm", "serde", "std"]
+
 [features]
 std = ["font-types/std"]
 codegen_test = []

diff --git a/read-fonts/src/lib.rs b/read-fonts/src/lib.rs
@@ -56,6 +56,7 @@
 //! [NameString]: tables::name::NameString
 //! [table-directory]: https://learn.microsoft.com/en-us/typography/opentype/spec/otff#table-directory
 
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![forbid(unsafe_code)]
 #![deny(rustdoc::broken_intra_doc_links)]
 #![cfg_attr(not(feature = "std"), no_std)]

diff --git a/skrifa/Cargo.toml b/skrifa/Cargo.toml
@@ -9,6 +9,11 @@ edition.workspace = true
 license.workspace = true
 repository.workspace = true
 
+[package.metadata.docs.rs]
+# To build locally:
+# RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+all-features = true
+
 [features]
 default = ["traversal"]
 std = ["read-fonts/std"]

diff --git a/skrifa/src/lib.rs b/skrifa/src/lib.rs
@@ -11,6 +11,7 @@
 //! See the [readme](https://github.com/googlefonts/fontations/blob/main/skrifa/README.md)
 //! for additional details.
 
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
 #![forbid(unsafe_code)]
 #![cfg_attr(not(any(test, feature = "std")), no_std)]
 

diff --git a/write-fonts/Cargo.toml b/write-fonts/Cargo.toml
@@ -9,6 +9,11 @@ edition.workspace = true
 license.workspace = true
 repository.workspace = true
 
+[package.metadata.docs.rs]
+# To build locally:
+# RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
+all-features = true
+
 [features]
 default = []
 read = []

diff --git a/write-fonts/src/lib.rs b/write-fonts/src/lib.rs
@@ -120,6 +120,8 @@
 //! [`FromTableRef`]: from_obj::FromTableRef
 //! [`ToOwnedTable`]: from_obj::ToOwnedTable
 
+#![cfg_attr(docsrs, feature(doc_auto_cfg))]
+
 mod collections;
 pub mod error;
 mod font_builder;