Skip to content

Commit

Permalink
Add docs.rs metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
Bromeon committed May 24, 2024
1 parent 0a9c7fb commit fd5128b
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 1 deletion.
7 changes: 6 additions & 1 deletion godot-bindings/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ license = "MPL-2.0"
keywords = ["gamedev", "godot", "engine", "ffi", "sys"]
categories = ["game-engines", "graphics"]

# Since features are additive and we want the user to user prebuilt by default, we need to have `prebuilt-godot` as the
# Since features are additive, and we want the user to user prebuilt by default, we need to have `prebuilt-godot` as the
# default feature. However, it's not possible to _disable_ the prebuilt dependency when specifying `api-custom` (without
# requiring no-default-features), so we unfortunately still need to depend on prebuilt and just ignore it.
# The artifact generator explicitly excludes that though (to avoid a quasi-circular dependency back to its repo).
Expand All @@ -34,3 +34,8 @@ which = { optional = true, version = "6" }
[dev-dependencies]
# For tests, we need regex unconditionally. Keep this in sync with above dependency.
regex = { version = "1.5.5", default-features = false, features = ["std", "unicode-gencat"] }

# https://docs.rs/about/metadata
[package.metadata.docs.rs]
features = ["experimental-godot-api"]
rustdoc-args = ["--cfg", "published_docs"]
5 changes: 5 additions & 0 deletions godot-cell/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,8 @@ proptest = ["dep:proptest"]

[dependencies]
proptest = { version = "1.4.0", optional = true }

# https://docs.rs/about/metadata
[package.metadata.docs.rs]
features = ["experimental-godot-api"]
rustdoc-args = ["--cfg", "published_docs"]
5 changes: 5 additions & 0 deletions godot-codegen/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,8 @@ regex = { version = "1.5.5", default-features = false, features = ["std", "unico

[build-dependencies]
godot-bindings = { path = "../godot-bindings" } # emit_godot_version_cfg

# https://docs.rs/about/metadata
[package.metadata.docs.rs]
features = ["experimental-godot-api"]
rustdoc-args = ["--cfg", "published_docs"]
5 changes: 5 additions & 0 deletions godot-core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,8 @@ serde_json = { version = "1.0" }
[build-dependencies]
godot-bindings = { path = "../godot-bindings" }
godot-codegen = { path = "../godot-codegen" }

# https://docs.rs/about/metadata
[package.metadata.docs.rs]
features = ["experimental-godot-api"]
rustdoc-args = ["--cfg", "published_docs"]
5 changes: 5 additions & 0 deletions godot-ffi/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,8 @@ gensym = "0.1.1"
[build-dependencies]
godot-bindings = { path = "../godot-bindings" }
godot-codegen = { path = "../godot-codegen" }

# https://docs.rs/about/metadata
[package.metadata.docs.rs]
features = ["experimental-godot-api"]
rustdoc-args = ["--cfg", "published_docs"]
7 changes: 7 additions & 0 deletions godot-fmt/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,20 @@
name = "godot-fmt"
version = "0.1.0"
edition = "2021"
rust-version = "1.78"
license = "MPL-2.0"
keywords = ["gamedev", "godot", "engine", "ffi"]
categories = ["game-engines", "graphics"]

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

[dependencies]
proc-macro2 = "1"

# https://docs.rs/about/metadata
[package.metadata.docs.rs]
features = ["experimental-godot-api"]
rustdoc-args = ["--cfg", "published_docs"]

# Disabled below, since it pulls in too many dependencies during `cargo test` but is not really used.
# Dev-dependencies cannot be optional and feature-gated. Enable manually when needed.
Expand Down
5 changes: 5 additions & 0 deletions godot-macros/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,8 @@ venial = "0.6"

[build-dependencies]
godot-bindings = { path = "../godot-bindings" } # emit_godot_version_cfg

# https://docs.rs/about/metadata
[package.metadata.docs.rs]
features = ["experimental-godot-api"]
rustdoc-args = ["--cfg", "published_docs"]
5 changes: 5 additions & 0 deletions godot/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,8 @@ trace = ["godot-core/trace"]
[dependencies]
godot-core = { path = "../godot-core" }
godot-macros = { path = "../godot-macros" }

# https://docs.rs/about/metadata
[package.metadata.docs.rs]
features = ["experimental-godot-api"]
rustdoc-args = ["--cfg", "published_docs"]

0 comments on commit fd5128b

Please sign in to comment.