Skip to content

Fix documentation build #133

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.

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
merged 2 commits into from
Mar 27, 2023
Merged

Fix documentation build #133

merged 2 commits into from
Mar 27, 2023

Conversation

fjarri
Copy link
Contributor

@fjarri fjarri commented Jan 2, 2023

  • Use doc_cfg and doc_auto_cfg during documentation build, to make the "available on crate feature <...>" label actually appear. doc_auto_cfg in particular figures out the placement of such labels automatically, so I could remove it from the Zeroize impl.
  • Fix imports in impl_zeroize.rs
  • cargo fmt run (also the reorder_imported_names option in rustfmt.toml seems to have been deprecated)

You can test it locally by running env RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features.

Currently in docs.rs:
Screen Shot 2023-01-02 at 12 42 25

Built with this PR:
Screen Shot 2023-01-02 at 12 42 47

tony-iqlusion added a commit to cometbft/tendermint-rs that referenced this pull request Mar 10, 2023
tony-iqlusion added a commit to cometbft/tendermint-rs that referenced this pull request Mar 10, 2023
The `generic-array` crate's docs won't build without this, which breaks
the docs build in CI
Co-authored-by: Tony Arcieri (iqlusion) <[email protected]>
@gakonst
Copy link

gakonst commented Mar 14, 2023

image

Hi @fjarri, do you have plans to get this over the line? We seem to be hitting some nightly docs error on CI cometbft/tendermint-rs#1285 (comment) and would love to resolve. Let us know! Thanks!!

@fjarri
Copy link
Contributor Author

fjarri commented Mar 14, 2023

Unfortunately I do not have control over this repo.

@gakonst
Copy link

gakonst commented Mar 15, 2023

oops my bad - cc @fizyk20

@tarcieri tarcieri mentioned this pull request Mar 27, 2023
Merged
2 tasks
@novacrazy novacrazy merged commit 0e9caee into fizyk20:master Mar 27, 2023
novacrazy added a commit that referenced this pull request Mar 28, 2023
@novacrazy
Copy link
Collaborator

novacrazy commented Mar 28, 2023

Backported this to 0.14.7

romac added a commit to cometbft/tendermint-rs that referenced this pull request Apr 4, 2023
* Bump `ed25519` => v2; `k256` => v0.13; `signature` => v2

Bumps all of the above dependencies to their latest versions, which use
the new `signature` v2 release:

RustCrypto/traits#1211

* Add `patch.crates-io` for fizyk20/generic-array#133

The `generic-array` crate's docs won't build without this, which breaks
the docs build in CI

* Remove workaround for docs build in CI

* Pin docs build to nightly-2023-03-01

It fails on newer versions:

https://github.com/informalsystems/tendermint-rs/actions/runs/4602897393/jobs/8132365869?pr=1285

* Add changelog entry

---------

Co-authored-by: Romain Ruetschi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants