Skip to content

Commit f2d4816

Browse files
committed
Enable Rustdoc examples scraping on docs.rs
1 parent d6eaf55 commit f2d4816

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

.github/workflows/ci.yml

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -176,12 +176,11 @@ jobs:
176176
uses: Swatinem/rust-cache@v2
177177
- name: Run rustdoc nightly
178178
run: |
179-
cd spdlog
180-
cargo +nightly rustdoc --verbose -- -D warnings -A rustdoc::broken-intra-doc-links
181-
cargo +nightly rustdoc --all-features --verbose -- -D warnings
182-
cd ../spdlog-macros
183-
cargo +nightly rustdoc --verbose -- -D warnings -A rustdoc::broken-intra-doc-links
184-
cargo +nightly rustdoc --all-features --verbose -- -D warnings
179+
RUSTDOCFLAGS='-D warnings -A rustdoc::broken-intra-doc-links'
180+
cargo +nightly doc --verbose -Z unstable-options -Z rustdoc-scrape-examples
181+
182+
RUSTDOCFLAGS='-D warnings'
183+
cargo +nightly doc --all-features --verbose -Z unstable-options -Z rustdoc-scrape-examples
185184
186185
check-msrv:
187186
needs: [matrix]

spdlog/Cargo.toml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ exclude = ["/benches"]
1212

1313
[package.metadata.docs.rs]
1414
all-features = true
15+
cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
1516

1617
[lib]
1718
name = "spdlog"
@@ -190,18 +191,23 @@ path = "benches/logforth/4_level_off.rs"
190191
[[example]]
191192
name = "06_log_crate"
192193
required-features = ["log"]
194+
doc-scrape-examples = true
193195
[[example]]
194196
name = "07_async"
195197
required-features = ["multi-thread"]
198+
doc-scrape-examples = true
196199
[[example]]
197200
name = "native_linux"
198201
path = "examples/native/linux.rs"
199202
required-features = ["native", "libsystemd"]
203+
doc-scrape-examples = true
200204
[[example]]
201205
name = "native_windows"
202206
path = "examples/native/windows.rs"
203207
required-features = ["native"]
208+
doc-scrape-examples = true
204209
[[example]]
205210
name = "native_android"
206211
path = "examples/native/android.rs"
207212
required-features = ["native", "android-ndk"]
213+
doc-scrape-examples = true

0 commit comments

Comments
 (0)