tests(iroh): Feature-flag the doc test

[flub]

Description

This test can only work if the feature is enabled. Feature-flag the
entire test contents.

Closes #2950.

Breaking Changes

Notes & open questions

Change checklist

• Self-review.
• Documentation updates following the style guide, if relevant.
• Tests if relevant.
• All breaking changes documented.

[github-actions]

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

Last updated: 2024-12-02T10:55:52Z

[dignifiedquire]

To also enable [LocalSwarmDiscovery], it can be added as another service in the

will still fail in cargo doc as the link is invalid with default features

[github-actions]

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: a1a6ec8

[flub]

To also enable [LocalSwarmDiscovery], it can be added as another service in the

will still fail in cargo doc as the link is invalid with default features

Do we support cargo doc without all features? How does docs.rs run cargo doc?

Should we not make sure CI fails on these things?

[dignifiedquire]

Do we support cargo doc without all features?

I think we should, because locally the initial thing you do is run cargo doc

Should we not make sure CI fails on these things?

we probably should

[flub]

We have

[package.metadata.docs.rs]
all-features = true

So I think everything will work fine. Of course you can argue this is not a great local experience. But neither is having some of the docs accidentally hidden when building locally. Not sure what to do here...

[dignifiedquire]

But neither is having some of the docs accidentally hidden when building locally

no need to hide things, just don't make it a link

[dignifiedquire]

beautiful 🤮

[flub]

You asked for this 😝