Skip to content

Generate macro expansion in rustdoc #883

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.

Sign up for GitHub

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

Merged
jonasbb merged 1 commit into from
Sep 19, 2025
+31 −1
Merged

Generate macro expansion in rustdoc #883

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions serde_with/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

### Fixed

* Show macro expansion in the docs.rs generated rustdoc.
Since macros are used to generate trait implementations, this is useful to understand the exact generated code.

## [3.14.0] - 2025-06-30

### Added
Expand Down
5 changes: 4 additions & 1 deletion serde_with/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,10 +266,13 @@ all-features = true
rustdoc-args = [
# Enable doc_cfg showing the required features.
"--cfg=docsrs",
"-Zunstable-options",
# Generate links to definition in rustdoc source code pages
# https://github.com/rust-lang/rust/pull/84176
"-Zunstable-options",
"--generate-link-to-definition",
# Generate buttons to show macro expansions in the rustdoc output.
# https://github.com/rust-lang/rust/pull/137229
"--generate-macro-expansion",
# Link to the stable documentation for core/alloc/std/proc_macro even though docs.rs uses nightly.
# https://github.com/rust-lang/docs.rs/issues/506#issuecomment-2670501688
"--extern-html-root-url=core=https://doc.rust-lang.org",
Expand Down
5 changes: 5 additions & 0 deletions serde_with_macros/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

### Fixed

* Show macro expansion in the docs.rs generated rustdoc.
Since macros are used to generate trait implementations, this is useful to understand the exact generated code.

## [3.14.0] - 2025-06-30

### Added
Expand Down
17 changes: 17 additions & 0 deletions serde_with_macros/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,23 @@ version-sync = "0.9.1"

[package.metadata.docs.rs]
all-features = true
rustdoc-args = [
# Enable doc_cfg showing the required features.
"--cfg=docsrs",
"-Zunstable-options",
# Generate links to definition in rustdoc source code pages
# https://github.com/rust-lang/rust/pull/84176
"--generate-link-to-definition",
# Generate buttons to show macro expansions in the rustdoc output.
# https://github.com/rust-lang/rust/pull/137229
"--generate-macro-expansion",
# Link to the stable documentation for core/alloc/std/proc_macro even though docs.rs uses nightly.
# https://github.com/rust-lang/docs.rs/issues/506#issuecomment-2670501688
"--extern-html-root-url=core=https://doc.rust-lang.org",
"--extern-html-root-url=alloc=https://doc.rust-lang.org",
"--extern-html-root-url=std=https://doc.rust-lang.org",
"--extern-html-root-url=proc_macro=https://doc.rust-lang.org",
]

[package.metadata.release]
pre-release-replacements = [
Expand Down
Loading