Skip to content

Commit e2aa6d3

Browse files
committed
Enable Rustdoc examples scraping on docs.rs
1 parent 9adfc8e commit e2aa6d3

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"
@@ -191,18 +192,23 @@ path = "benches/logforth/4_level_off.rs"
191192
[[example]]
192193
name = "06_log_crate"
193194
required-features = ["log"]
195+
doc-scrape-examples = true
194196
[[example]]
195197
name = "07_async"
196198
required-features = ["multi-thread"]
199+
doc-scrape-examples = true
197200
[[example]]
198201
name = "native_linux"
199202
path = "examples/native/linux.rs"
200203
required-features = ["native", "libsystemd"]
204+
doc-scrape-examples = true
201205
[[example]]
202206
name = "native_windows"
203207
path = "examples/native/windows.rs"
204208
required-features = ["native"]
209+
doc-scrape-examples = true
205210
[[example]]
206211
name = "native_android"
207212
path = "examples/native/android.rs"
208213
required-features = ["native", "android-ndk"]
214+
doc-scrape-examples = true

0 commit comments

Comments
 (0)