Skip to content

Commit 5f54493

Browse files
authored
docs: fix docs.rs docs generation (#3514)
## 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 <!-- Remove any that are not relevant. --> - [ ] 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. - [ ] 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: - [ ] [`quic-rpc`](https://github.com/n0-computer/quic-rpc) - [ ] [`iroh-gossip`](https://github.com/n0-computer/iroh-gossip) - [ ] [`iroh-blobs`](https://github.com/n0-computer/iroh-blobs) - [ ] [`dumbpipe`](https://github.com/n0-computer/dumbpipe) - [ ] [`sendme`](https://github.com/n0-computer/sendme)
1 parent 7a8b97c commit 5f54493

File tree

10 files changed

+11
-10
lines changed

10 files changed

+11
-10
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ jobs:
256256
- uses: actions/checkout@v5
257257
- uses: dtolnay/rust-toolchain@master
258258
with:
259-
toolchain: nightly-2025-02-20
259+
toolchain: nightly-2025-10-09
260260
- name: Install sccache
261261
uses: mozilla-actions/[email protected]
262262

.github/workflows/docs.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
- uses: actions/checkout@v5
3333
- uses: dtolnay/rust-toolchain@master
3434
with:
35-
toolchain: nightly-2025-02-20
35+
toolchain: nightly-2025-10-09
3636
- name: Install sccache
3737
uses: mozilla-actions/[email protected]
3838

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ missing_debug_implementations = "warn"
3434
# feature in any dependencies, because some indirect dependencies
3535
# require a feature enabled when using `--cfg docsrs` which we can not
3636
# do. To enable for a crate set `#![cfg_attr(iroh_docsrs,
37-
# feature(doc_auto_cfg))]` in the crate.
37+
# feature(doc_cfg))]` in the crate.
3838
# We also have our own `iroh_loom` cfg to enable tokio-rs/loom testing.
3939
unexpected_cfgs = { level = "warn", check-cfg = ["cfg(iroh_docsrs)", "cfg(iroh_loom)"] }
4040

iroh-base/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! Base types and utilities for Iroh
2-
#![cfg_attr(iroh_docsrs, feature(doc_auto_cfg))]
2+
#![cfg_attr(iroh_docsrs, feature(doc_cfg))]
33
#![deny(missing_docs, rustdoc::broken_intra_doc_links)]
44
#![cfg_attr(not(test), deny(clippy::unwrap_used))]
55

iroh-base/src/ticket/node.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ use crate::{
2727
/// [`NodeId`]: crate::key::NodeId
2828
/// [`Display`]: std::fmt::Display
2929
/// [`FromStr`]: std::str::FromStr
30+
/// ['RelayUrl`]: crate::relay_url::RelayUrl
3031
#[derive(Debug, Clone, PartialEq, Eq, derive_more::Display)]
3132
#[display("{}", Ticket::serialize(self))]
3233
pub struct NodeTicket {

iroh-relay/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
//! QAD support and expose metrics.
2727
// Based on tailscale/derp/derp.go
2828

29-
#![cfg_attr(iroh_docsrs, feature(doc_auto_cfg))]
29+
#![cfg_attr(iroh_docsrs, feature(doc_cfg))]
3030
#![deny(missing_docs, rustdoc::broken_intra_doc_links)]
3131
#![cfg_attr(not(test), deny(clippy::unwrap_used))]
3232

iroh-relay/src/node_info.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,12 +89,12 @@ pub enum DecodingError {
8989
pub trait NodeIdExt {
9090
/// Encodes a [`NodeId`] in [`z-base-32`] encoding.
9191
///
92-
/// [z-base-32]: https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt
92+
/// [`z-base-32`]: https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt
9393
fn to_z32(&self) -> String;
9494

9595
/// Parses a [`NodeId`] from [`z-base-32`] encoding.
9696
///
97-
/// [z-base-32]: https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt
97+
/// [`z-base-32`]: https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt
9898
fn from_z32(s: &str) -> Result<NodeId, DecodingError>;
9999
}
100100

iroh/src/discovery/dns.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ pub(crate) const DNS_STAGGERING_MS: &[u64] = &[200, 300];
3232
/// The DNS resolver defaults to using the nameservers configured on the host system, but can be changed
3333
/// with [`crate::endpoint::Builder::dns_resolver`].
3434
///
35-
/// [z-base-32]: https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt
35+
/// [`z-base-32`]: https://philzimmermann.com/docs/human-oriented-base-32-encoding.txt
3636
/// [`Endpoint`]: crate::Endpoint
3737
#[derive(Debug)]
3838
pub struct DnsDiscovery {

iroh/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@
250250
#![deny(missing_docs, rustdoc::broken_intra_doc_links)]
251251
#![cfg_attr(wasm_browser, allow(unused))]
252252
#![cfg_attr(not(test), deny(clippy::unwrap_used))]
253-
#![cfg_attr(iroh_docsrs, feature(doc_auto_cfg))]
253+
#![cfg_attr(iroh_docsrs, feature(doc_cfg))]
254254

255255
mod disco;
256256
mod key;

iroh/src/net_report.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
//! etc and reachability to the configured relays.
66
// Based on <https://github.com/tailscale/tailscale/blob/main/net/netcheck/netcheck.go>
77

8-
#![cfg_attr(iroh_docsrs, feature(doc_auto_cfg))]
8+
#![cfg_attr(iroh_docsrs, feature(doc_cfg))]
99
#![deny(missing_docs, rustdoc::broken_intra_doc_links)]
1010
#![cfg_attr(not(test), deny(clippy::unwrap_used))]
1111
#![cfg_attr(wasm_browser, allow(unused))]

0 commit comments

Comments
 (0)