Skip to content

docs: fix docs.rs docs generation#3514

Merged
rklaehn merged 2 commits intomainfrom
fix-docs-rs
Oct 9, 2025
Merged

docs: fix docs.rs docs generation#3514
rklaehn merged 2 commits intomainfrom
fix-docs-rs

Conversation

@rklaehn
Copy link
Copy Markdown
Contributor

@rklaehn rklaehn commented Oct 9, 2025

Description

Try to fix docs.rs docs generation

  • fix some links
  • replace doc_auto_cfg with doc_cfg as instructed by the failed docs.rs run

[INFO] [stderr] 253 | #![cfg_attr(iroh_docsrs, feature(doc_auto_cfg))]
[INFO] [stderr] | ^^^^^^^^^^^^ feature has been removed
[INFO] [stderr] |
[INFO] [stderr] = note: removed in CURRENT_RUSTC_VERSION; see rust-lang/rust#138907 for more information
[INFO] [stderr] = note: merged into doc_cfg

Breaking Changes

None

Notes & open questions

Not sure how to test this.

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.
    • List all breaking changes in the above "Breaking Changes" section.
    • Open an issue or PR on any number0 repos that are affected by this breaking change. Give guidance on how the updates should be handled or do the actual updates themselves. The major ones are:

@rklaehn
chore: Try to fix docs.rs docs generation
b082ee1 
- fix some links
- replace doc_auto_cfg with doc_cfg as instructed by the failed docs.rs run

[INFO] [stderr] 253 | #![cfg_attr(iroh_docsrs, feature(doc_auto_cfg))]
[INFO] [stderr]     |                                  ^^^^^^^^^^^^ feature has been removed
[INFO] [stderr]     |
[INFO] [stderr]     = note: removed in CURRENT_RUSTC_VERSION; see <rust-lang/rust#138907> for more information
[INFO] [stderr]     = note: merged into `doc_cfg`
@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 9, 2025 •
edited
Loading

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/3514/docs/iroh/

Last updated: 2025-10-09T10:00:32Z

@github-actions
Copy link
Copy Markdown

github-actions bot commented Oct 9, 2025 •
edited
Loading

Netsim report & logs for this PR have been generated and is available at: LOGS
This report will remain available for 3 days.

Last updated for commit: 5583df7

@Frando
Copy link
Copy Markdown
Member

Frando commented Oct 9, 2025

Maybe let's update all nightly toolchain uses in one go?

~/Code/rust/iroh/.github main*
$ rg nightly
workflows/docs.yaml
35:        toolchain: nightly-2025-02-20

workflows/ci.yml
259:          toolchain: nightly-2025-02-20

workflows/tests.yaml
259:      - uses: dtolnay/rust-toolchain@nightly
263:          cargo +nightly check -Z minimal-versions --workspace --all-features --lib --bins
290:      - name: Install Rust nightly
292:          rustup toolchain install nightly
306:          cargo +nightly check -Z minimal-versions --workspace --all-features --lib --bins

@rklaehn
Copy link
Copy Markdown
Contributor Author

rklaehn commented Oct 9, 2025

workflows/tests.yaml
259: - uses: dtolnay/rust-toolchain@nightly
263: cargo +nightly check -Z minimal-versions --workspace --all-features --lib --bins
290: - name: Install Rust nightly
292: rustup toolchain install nightly
306: cargo +nightly check -Z minimal-versions --workspace --all-features --lib --bins

Yeah, you are right. Missed the one in docs.yaml. For the ones in tests.yaml there is nothing to do since they don't mention explicit versions, right?

@rklaehn
Copy link
Copy Markdown
Contributor Author

rklaehn commented Oct 9, 2025 •
edited
Loading

Did a quick check. Main does indeed fail with latest nightly:
https://github.com/n0-computer/iroh/actions/runs/18372716206/job/52339533583?pr=3515

#![cfg_attr(iroh_docsrs, feature(doc_auto_cfg))]

@n0bot n0bot bot added this to iroh Oct 9, 2025
@github-project-automation github-project-automation bot moved this to 🏗 In progress in iroh Oct 9, 2025
@dignifiedquire dignifiedquire changed the title chore: Try to fix docs.rs docs generation docs: fix docs.rs docs generation Oct 9, 2025
@dignifiedquire
Copy link
Copy Markdown
Contributor

dignifiedquire commented Oct 9, 2025

@ramfox we should do a patch release with just this, to make sure docs.rs is fixed

@rklaehn rklaehn added this pull request to the merge queue Oct 9, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Oct 9, 2025
@rklaehn rklaehn added this pull request to the merge queue Oct 9, 2025
Merged via the queue into main with commit 5f54493 Oct 9, 2025
54 of 55 checks passed
@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in iroh Oct 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@dignifiedquire dignifiedquire dignifiedquire approved these changes

Assignees

No one assigned

Labels

None yet

Projects

iroh
Status: ✅ Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@rklaehn @Frando @dignifiedquire