Skip to content

Commit

Permalink
docs(iroh): Enable iroh_docsrs feature (#2780)
Browse files Browse the repository at this point in the history
## Description

This uses the same iroh_docsrs cfg as the other crates and updates the
preview CI job to also use this.

## Breaking Changes

None

## Notes & open questions

However, the world is a sad place.

As far as I can figure out this all correctly annotates the features in
our docs in the individual crates. That is, `https://docs.rs/iroh-net`
and `https://docs.rs/iroh-gossip` etc. This is also true for the `iroh`
crate. BUT, the iroh crate uses `doc(inline)` on the other crates, and
when using this we can not get the feature annotation in the sub-crates.
Sad times.

## Change checklist

- [x] Self-review.
- ~~[ ] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.~~
- ~~[ ] Tests if relevant.~~
- ~~[ ] All breaking changes documented.~~
  • Loading branch information
flub authored Oct 15, 2024
1 parent 1a3e363 commit 28d902e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
- name: Generate Docs
run: cargo doc --workspace --all-features --no-deps
env:
RUSTDOCFLAGS: --cfg docsrs
RUSTDOCFLAGS: --cfg iroh_docsrs

- name: Deploy Docs to Preview Branch
uses: peaceiris/actions-gh-pages@v4
Expand Down

0 comments on commit 28d902e

Please sign in to comment.