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.

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

doc: __abi-generate feature in docs.rs #1286

Merged
merged 4 commits into from
Dec 24, 2024
+11 −5
Merged

doc: __abi-generate feature in docs.rs #1286

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f6b20a3
doc: add `__abi-generate` for docs.rs of `near-sdk`
Dec 23, 2024
573afc2
doc: add `__abi-generate` for docs.rs of `near-sdk-macros`
Dec 23, 2024
ee162d3
doc: add `abi` feature for docs.rs of `near-contract-standards`
Dec 23, 2024
2ebd705
ci: update workflows to test doc with __abi-generate or abi features
Dec 23, 2024
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
6 changes: 3 additions & 3 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ jobs:
env:
RUSTDOCFLAGS: -D warnings
run: |
cargo doc -p near-sdk --features unstable,legacy,unit-testing,__macro-docs
cargo doc -p near-sdk-macros
cargo doc -p near-contract-standards --no-deps
cargo doc -p near-sdk --features unstable,legacy,unit-testing,__macro-docs,__abi-generate
cargo doc -p near-sdk-macros --features __abi-generate
cargo doc -p near-contract-standards --no-deps --features abi
cargo doc -p near-sys
5 changes: 4 additions & 1 deletion near-contract-standards/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,7 @@ near-sdk = { path = "../near-sdk", default-features = false, features = [

[features]
default = []
abi = ["near-sdk/abi"]
abi = ["near-sdk/__abi-generate"]

[package.metadata.docs.rs]
features = ["abi"]
3 changes: 3 additions & 0 deletions near-sdk-macros/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,6 @@ prettyplease = { version = "0.2.15" }
abi = []
__abi-embed = ["abi"]
__abi-generate = ["abi"]

[package.metadata.docs.rs]
features = ["__abi-generate"]
2 changes: 1 addition & 1 deletion near-sdk/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,4 +98,4 @@ __abi-generate = ["abi", "near-sdk-macros/__abi-generate"]
__macro-docs = []

[package.metadata.docs.rs]
features = ["unstable", "legacy", "unit-testing", "__macro-docs"]
features = ["unstable", "legacy", "unit-testing", "__macro-docs", "__abi-generate"]
Loading