fix(docs): enable tauri/dox feature on docs.rs build (#545)

tauri-apps · Aug 10, 2023 · d5a7c77 · d5a7c77
1 parent 4ab90f0
commit d5a7c77
Show file tree

Hide file tree

Showing 28 changed files with 111 additions and 2 deletions.
diff --git a/.changes/fix-docs-build.md b/.changes/fix-docs-build.md
@@ -0,0 +1,31 @@
+---
+"app": patch
+"authenticator": patch
+"autostart": patch
+"cli": patch
+"clipboard-manager": patch
+"dialog": patch
+"fs": patch
+"global-shortcut": patch
+"http": patch
+"localhost": patch
+"log-plugin": patch
+"notification": patch
+"os": patch
+"persisted-scope": patch
+"positioner": patch
+"process": patch
+"shell": patch
+"single-instance": patch
+"sql": patch
+"store": patch
+"stronghold": patch
+"updater": patch
+"upload": patch
+"websocket": patch
+"window": patch
+"window-state": patch
+---
+
+Fixes docs.rs build by enabling the `tauri/dox` feature flag.
+
diff --git a/plugins/app/Cargo.toml b/plugins/app/Cargo.toml
@@ -6,5 +6,8 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 tauri = { workspace = true }
diff --git a/plugins/authenticator/Cargo.toml b/plugins/authenticator/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/autostart/Cargo.toml b/plugins/autostart/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/cli/Cargo.toml b/plugins/cli/Cargo.toml
@@ -6,6 +6,9 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/clipboard-manager/Cargo.toml b/plugins/clipboard-manager/Cargo.toml
@@ -7,6 +7,9 @@ authors = { workspace = true }
 license = { workspace = true }
 links = "tauri-plugin-clipboard-manager"
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [build-dependencies]
 tauri-build = { workspace = true }
 

diff --git a/plugins/dialog/Cargo.toml b/plugins/dialog/Cargo.toml
@@ -7,6 +7,9 @@ authors = { workspace = true }
 license = { workspace = true }
 links = "tauri-plugin-dialog"
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/fs/Cargo.toml b/plugins/fs/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 tauri = { workspace = true }

diff --git a/plugins/global-shortcut/Cargo.toml b/plugins/global-shortcut/Cargo.toml
@@ -6,6 +6,9 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/http/Cargo.toml b/plugins/http/Cargo.toml
@@ -6,6 +6,9 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/localhost/Cargo.toml b/plugins/localhost/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/log/Cargo.toml b/plugins/log/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [build-dependencies]
 tauri-build = { workspace = true }
 

diff --git a/plugins/notification/Cargo.toml b/plugins/notification/Cargo.toml
@@ -7,6 +7,9 @@ authors = { workspace = true }
 license = { workspace = true }
 links = "tauri-plugin-notification"
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [build-dependencies]
 tauri-build = { workspace = true }
 

diff --git a/plugins/os/Cargo.toml b/plugins/os/Cargo.toml
@@ -6,6 +6,9 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/persisted-scope/Cargo.toml b/plugins/persisted-scope/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/positioner/Cargo.toml b/plugins/positioner/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/process/Cargo.toml b/plugins/process/Cargo.toml
@@ -6,5 +6,8 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 tauri = { workspace = true }
diff --git a/plugins/shell/Cargo.toml b/plugins/shell/Cargo.toml
@@ -6,6 +6,9 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/single-instance/Cargo.toml b/plugins/single-instance/Cargo.toml
@@ -8,6 +8,9 @@ edition = { workspace = true }
 rust-version = { workspace = true }
 exclude = [ "/examples" ]
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/sql/Cargo.toml b/plugins/sql/Cargo.toml
@@ -8,7 +8,7 @@ edition = { workspace = true }
 rust-version = { workspace = true }
 
 [package.metadata.docs.rs]
-features = [ "sqlite" ]
+features = [ "dox", "sqlite" ]
 
 [dependencies]
 serde = { workspace = true }

diff --git a/plugins/store/Cargo.toml b/plugins/store/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/stronghold/Cargo.toml b/plugins/stronghold/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/updater/Cargo.toml b/plugins/updater/Cargo.toml
@@ -6,6 +6,9 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 tauri = { workspace = true }
 serde = { workspace = true }

diff --git a/plugins/upload/Cargo.toml b/plugins/upload/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/websocket/Cargo.toml b/plugins/websocket/Cargo.toml
@@ -8,6 +8,9 @@ edition = { workspace = true }
 rust-version = { workspace = true }
 exclude = [ "/examples" ]
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/window-state/Cargo.toml b/plugins/window-state/Cargo.toml
@@ -7,6 +7,9 @@ license = { workspace = true }
 edition = { workspace = true }
 rust-version = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 serde = { workspace = true }
 serde_json = { workspace = true }

diff --git a/plugins/window/Cargo.toml b/plugins/window/Cargo.toml
@@ -6,6 +6,9 @@ edition = { workspace = true }
 authors = { workspace = true }
 license = { workspace = true }
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 [dependencies]
 tauri = { workspace = true }
 serde = { workspace = true }

diff --git a/shared/template/Cargo.toml b/shared/template/Cargo.toml
@@ -6,6 +6,9 @@ authors = { workspace = true }
 license = { workspace = true }
 links = "tauri-plugin-{{name}}"
 
+[package.metadata.docs.rs]
+features = [ "tauri/dox" ]
+
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [build-dependencies]
@@ -16,4 +19,4 @@ serde = { workspace = true }
 serde_json = { workspace = true }
 tauri = { workspace = true }
 log = { workspace = true }
-thiserror = { workspace = true }
+thiserror = { workspace = true }