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 example code from examples/* #195

Merged
merged 1 commit into from
May 24, 2023
Merged

Conversation

joshka
Copy link
Member

@joshka joshka commented May 24, 2023

see https://doc.rust-lang.org/nightly/rustdoc/scraped-examples.html

I noticed this in another library and thought it was a pretty neat idea. We have a bunch of examples that we can use for this.

Here's how it shows up:

image

To test this locally, use:

rustup toolchain add nightly
cargo +nightly doc -Zunstable-options -Zrustdoc-scrape-examples --all-features --open

Copy link
Member

@orhun orhun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, pretty neat feature 🦀

@joshka joshka merged commit 49e0f4e into main May 24, 2023
@joshka joshka deleted the docs-scrape-examples branch July 4, 2023 21:02
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

Successfully merging this pull request may close these issues.

3 participants