Skip to content

Commit

Permalink
docs: enable some useful rustdoc features on docs.rs (#28)
Browse files Browse the repository at this point in the history
  • Loading branch information
DaniPopes authored Jan 5, 2025
1 parent 8794306 commit ee24cea
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 40 deletions.
16 changes: 3 additions & 13 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ jobs:
- name: Build documentation
run: cargo doc --workspace --all-features --no-deps --document-private-items
env:
RUSTDOCFLAGS: --cfg docsrs -D warnings --show-type-layout --generate-link-to-definition -Zunstable-options
RUSTDOCFLAGS: --cfg docsrs -D warnings -Zunstable-options --show-type-layout --generate-link-to-definition

fmt:
runs-on: ubuntu-latest
Expand All @@ -174,15 +174,5 @@ jobs:
components: rustfmt
- run: cargo fmt --all --check

cfg-check:
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
- uses: dtolnay/rust-toolchain@nightly
with:
toolchain: nightly
- uses: Swatinem/rust-cache@v2
with:
cache-on-failure: true
- run: cargo check -Zcheck-cfg --workspace
deny:
uses: ithacaxyz/ci/.github/workflows/deny.yml@main
18 changes: 0 additions & 18 deletions .github/workflows/deps.yml

This file was deleted.

4 changes: 0 additions & 4 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,6 @@ use-self = "warn"
option-if-let-else = "warn"
redundant-clone = "warn"

[workspace.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]

[workspace.dependencies]
alloy-primitives = { version = "0.8.10", default-features = false }
alloy-rlp = { version = "0.3", default-features = false }
Expand Down
6 changes: 5 additions & 1 deletion crates/eip2124/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ repository.workspace = true

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
rustdoc-args = [
"-Zunstable-options",
"--generate-link-to-definition",
"--show-type-layout",
]

[lints]
workspace = true
Expand Down
7 changes: 5 additions & 2 deletions crates/eip2930/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ repository.workspace = true

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
rustdoc-args = [
"-Zunstable-options",
"--generate-link-to-definition",
"--show-type-layout",
]

[lints]
workspace = true
Expand All @@ -28,7 +32,6 @@ serde = { workspace = true, optional = true }
arbitrary = { workspace = true, features = ["derive"], optional = true }
rand = { workspace = true, optional = true }


[dev-dependencies]
serde_json.workspace = true

Expand Down
10 changes: 8 additions & 2 deletions crates/eip7702/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ repository.workspace = true

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
rustdoc-args = [
"-Zunstable-options",
"--generate-link-to-definition",
"--show-type-layout",
]

[lints]
workspace = true
Expand All @@ -23,7 +27,9 @@ alloy-rlp = { workspace = true, features = ["derive"] }

# serde
serde = { workspace = true, optional = true }
serde_with = { version = "3", optional = true, default-features = false, features = ["macros"] }
serde_with = { version = "3", optional = true, default-features = false, features = [
"macros",
] }

# arbitrary
arbitrary = { workspace = true, features = ["derive"], optional = true }
Expand Down

0 comments on commit ee24cea

Please sign in to comment.