Skip to content

Commit

Permalink
scripts: ➕ penumbra-fee and penumbra-stake in rust docs (#3932)
Browse files Browse the repository at this point in the history
fixes #3930.

commit 2944884
Author: katelyn martin <[email protected]>
Date:   Mon Mar 4 11:14:19 2024 -0500

    docs: 📰 update `index.html`
    
    NB: this file seems to have gotten stale, so there is additional drift
    here. see `git show --word-diff`.

commit 0ed2eb5
Author: katelyn martin <[email protected]>
Date:   Mon Mar 4 11:13:14 2024 -0500

    fee: 🌜 `docsrs` build enables `doc_cfg` feature
    
    this is needed when building with `cargo +nightly`.

commit aab5331
Author: katelyn martin <[email protected]>
Date:   Mon Mar 4 11:10:40 2024 -0500

    fee: 🦋 add `rpc` feature to penumbra-proto dependency
    
    this is implicitly added when the crate is built as part of
    `cargo build --workspace`, but the crate cannot be built individually
    via `cargo build -p penumbra-fee` without this feature.

commit 172e7cf
Author: katelyn martin <[email protected]>
Date:   Mon Mar 4 10:57:07 2024 -0500

    scripts: ❗ use `env` in shebang

commit 16794d8
Author: katelyn martin <[email protected]>
Date:   Mon Mar 4 10:51:16 2024 -0500

    scripts: ✨ add penumbra-stake to rust docs

commit 4d22c7e
Author: katelyn martin <[email protected]>
Date:   Mon Mar 4 10:41:13 2024 -0500

    scripts: ➕ add `penumbra-fee` to rust docs
    
    fixes #3930.

commit abab6d6
Author: katelyn martin <[email protected]>
Date:   Mon Mar 4 10:39:42 2024 -0500

    scripts: 🧹 sort package list
  • Loading branch information
cratelyn authored Mar 4, 2024
1 parent 5863116 commit 66e6c7e
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 22 deletions.
2 changes: 1 addition & 1 deletion crates/core/component/fee/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ decaf377-rdsa = {workspace = true}
metrics = {workspace = true}
penumbra-asset = {workspace = true, default-features = false}
penumbra-num = {workspace = true, default-features = false}
penumbra-proto = {workspace = true, default-features = false}
penumbra-proto = {workspace = true, features = ["rpc"], default-features = false}
rand = {workspace = true}
rand_core = {workspace = true, features = ["getrandom"]}
serde = {workspace = true, features = ["derive"]}
Expand Down
2 changes: 1 addition & 1 deletion crates/core/component/fee/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#![deny(clippy::unwrap_used)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]

#[cfg_attr(docsrs, doc(cfg(feature = "component")))]
#[cfg(feature = "component")]
Expand Down
38 changes: 20 additions & 18 deletions deployments/scripts/rust-docs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/bash
#!/usr/bin/env bash
# Rebuild Rust crate documentation
set -euo pipefail

Expand All @@ -18,47 +18,49 @@ export RUSTDOCFLAGS="--enable-index-page -Zunstable-options --cfg docsrs"
# indexes is overwritten on each cargo doc invocation.

cargo +nightly doc --no-deps \
-p tendermint \
-p tendermint-config \
-p ibc-types \
-p tower-abci \
-p jmt \
-p ark-ff \
-p ark-serialize \
-p poseidon377 \
-p poseidon-paramgen \
-p poseidon-permutation \
-p [email protected] \
-p decaf377-rdsa \
-p decaf377-fmd \
-p decaf377-ka \
-p cnidarium \
-p cnidarium-component \
-p decaf377-fmd \
-p decaf377-ka \
-p decaf377-rdsa \
-p [email protected] \
-p ibc-types \
-p jmt \
-p pcli \
-p pclientd \
-p pd \
-p penumbra-app \
-p penumbra-asset \
-p penumbra-custody \
-p penumbra-community-pool \
-p penumbra-custody \
-p penumbra-dex \
-p penumbra-distributions \
-p penumbra-fee \
-p penumbra-genesis \
-p penumbra-governance \
-p penumbra-ibc \
-p penumbra-keys \
-p penumbra-txhash \
-p penumbra-measure \
-p penumbra-num \
-p penumbra-proof-params \
-p penumbra-proof-setup \
-p penumbra-proto \
-p penumbra-sct \
-p penumbra-shielded-pool \
-p penumbra-stake \
-p penumbra-tct \
-p penumbra-transaction \
-p penumbra-txhash \
-p penumbra-view \
-p penumbra-wallet \
-p pd \
-p pclientd \
-p pcli \
-p poseidon-paramgen \
-p poseidon-permutation \
-p poseidon377 \
-p tendermint \
-p tendermint-config \
-p tower-abci \

>&2 echo "Copying newly built index file to version-controlled path:"
cp -v target/doc/index.html docs/rustdoc/index.html
Loading

0 comments on commit 66e6c7e

Please sign in to comment.