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.

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

docs scrape examples #233

Open
Vrixyz opened this issue Jul 18, 2024 · 0 comments
Open

docs scrape examples #233

Vrixyz opened this issue Jul 18, 2024 · 0 comments

Comments

@Vrixyz
Copy link
Contributor

Vrixyz commented Jul 18, 2024

docs.rs can link to examples which is helpful for understanding:

image

Part diff

index 5603c71..c90c83f 100644
--- a/crates/parry3d/Cargo.toml
+++ b/crates/parry3d/Cargo.toml
@@ -69,3 +81,13 @@ rstar = "0.12.0"
 oorandom = "11"
 ptree = "0.4.0"
 rand = { version = "0.8" }
+
+[[example]]
+name = "solid_ray_cast3d"
+path = "examples/solid_ray_cast3d.rs"
+doc-scrape-examples = true
+
+[package.metadata.docs.rs]
+rustdoc-args = ["-Zunstable-options", "--cfg", "docsrs"]
+all-features = true
+cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]

This was referenced Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant