Merge pull request #89 from madsmtm/docs-rs

Fix docs.rs setup

Author: madsmtm

block-sys/Cargo.toml

@@ -48,3 +48,6 @@ objfw = []
 
 [dependencies]
 objc-sys = { path = "../objc-sys", version = "0.1.0", optional = true }
+
+[package.metadata.docs.rs]
+default-target = "x86_64-apple-darwin"

block2/Cargo.toml

@@ -21,3 +21,6 @@ license = "MIT"
 # Loose dependency, because objc2-encode is not expected to change much more
 objc2-encode = { path = "../objc2-encode", version = "^2.0.0-beta.0" }
 block-sys = { path = "../block-sys", version = "0.0.1" }
+
+[package.metadata.docs.rs]
+default-target = "x86_64-apple-darwin"

objc-sys/Cargo.toml

@@ -46,3 +46,20 @@ winobjc = ["gnustep-1-8"]
 
 # TODO
 objfw = []
+
+[package.metadata.docs.rs]
+default-target = "x86_64-apple-darwin"
+
+targets = [
+    # MacOS
+    "x86_64-apple-darwin",
+    "i686-apple-darwin",
+    # iOS
+    "aarch64-apple-ios",
+    "x86_64-apple-ios",
+    # GNUStep
+    "x86_64-unknown-linux-gnu",
+    "i686-unknown-linux-gnu",
+]
+
+cargo-args = ["-Z", "build-std"]

objc-sys/build.rs

@@ -117,7 +117,16 @@ fn main() {
             unimplemented!()
         }
         (false, false, false) => {
-            panic!("Must specify the desired runtime (using features) on non-apple platforms.")
+            // Choose sensible defaults when generating docs
+            if std::env::var("DOCS_RS").is_ok() {
+                if target_os == "windows" {
+                    WinObjC
+                } else {
+                    GNUStep(1, 7)
+                }
+            } else {
+                panic!("Must specify the desired runtime (using features) on non-apple platforms.")
+            }
         }
         _ => {
             panic!("Invalid feature combination; only one runtime may be selected!")
@@ -173,7 +182,8 @@ fn main() {
                 (MacOS(_), _) => "macosx",
                 (IOS(_), _) => "ios",
                 (WatchOS(_), _) => "watchos",
-                (TvOS(_), _) => "ios", // ??
+                // tvOS doesn't have it's own -fobjc-runtime string
+                (TvOS(_), _) => "ios",
             };
             match runtime {
                 MacOS(version) | IOS(version) | WatchOS(version) | TvOS(version) => {

objc2-encode/Cargo.toml

@@ -17,3 +17,6 @@ readme = "README.md"
 repository = "https://github.com/madsmtm/objc2"
 documentation = "https://docs.rs/objc2-encode/"
 license = "MIT"
+
+[package.metadata.docs.rs]
+default-target = "x86_64-apple-darwin"

objc2-foundation/Cargo.toml

@@ -28,3 +28,6 @@ block = ["block2"]
 block2 = { path = "../block2", version = "=0.2.0-alpha.1", optional = true }
 objc2 = { path = "../objc2", version = "=0.3.0-alpha.4" }
 objc-sys = { path = "../objc-sys", version = "0.1.0" }
+
+[package.metadata.docs.rs]
+default-target = "x86_64-apple-darwin"

objc2/Cargo.toml

@@ -35,3 +35,22 @@ objc2-encode = { path = "../objc2-encode", version = "^2.0.0-beta.0" }
 
 [build-dependencies]
 cc = { version = "1", optional = true }
+
+[package.metadata.docs.rs]
+default-target = "x86_64-apple-darwin"
+
+features = ["exception"]
+
+targets = [
+    # MacOS
+    "x86_64-apple-darwin",
+    "i686-apple-darwin",
+    # iOS
+    "aarch64-apple-ios",
+    "x86_64-apple-ios",
+    # GNUStep
+    "x86_64-unknown-linux-gnu",
+    "i686-unknown-linux-gnu",
+]
+
+cargo-args = ["-Z", "build-std"]

objc2/build.rs

@@ -9,6 +9,11 @@ fn main() {
 
     #[cfg(feature = "exception")]
     {
+        if std::env::var("DOCS_RS").is_ok() {
+            // docs.rs doesn't have clang, so skip building this. The
+            // documentation will still work since it doesn't need to link.
+            return;
+        }
         println!("cargo:rerun-if-changed=extern/exception.m");
 
         let mut builder = cc::Build::new();