Skip to content

Commit

Permalink
use auto docs (#21)
Browse files Browse the repository at this point in the history
also fix links in README.md so we don't get a warning for naked links
  • Loading branch information
rklaehn authored Dec 13, 2024
1 parent 98e2e17 commit 6b05f0e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ async fn main() -> anyhow::Result<()> {
This project is licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
http://www.apache.org/licenses/LICENSE-2.0)
<http://www.apache.org/licenses/LICENSE-2.0>)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or
http://opensource.org/licenses/MIT)
<http://opensource.org/licenses/MIT>)

at your option.

Expand Down
10 changes: 1 addition & 9 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,28 +33,22 @@
//!
//! [paper]: https://arxiv.org/abs/2212.13567
#![deny(missing_docs, rustdoc::broken_intra_doc_links)]
#![cfg_attr(iroh_docsrs, feature(doc_cfg))]
#![cfg_attr(iroh_docsrs, feature(doc_auto_cfg))]

pub mod metrics;
#[cfg(feature = "net")]
#[cfg_attr(iroh_docsrs, doc(cfg(feature = "net")))]
pub mod net;
#[cfg(feature = "engine")]
#[cfg_attr(iroh_docsrs, doc(cfg(feature = "engine")))]
pub mod protocol;
#[cfg(feature = "net")]
#[cfg_attr(iroh_docsrs, doc(cfg(feature = "net")))]
mod ticket;

#[cfg(feature = "engine")]
#[cfg_attr(iroh_docsrs, doc(cfg(feature = "engine")))]
pub mod engine;
#[cfg(feature = "rpc")]
#[cfg_attr(iroh_docsrs, doc(cfg(feature = "rpc")))]
pub mod rpc;

#[cfg(feature = "cli")]
#[cfg_attr(iroh_docsrs, doc(cfg(feature = "cli")))]
pub mod cli;

pub mod actor;
Expand All @@ -66,11 +60,9 @@ mod keys;
mod ranger;

#[cfg(feature = "net")]
#[cfg_attr(iroh_docsrs, doc(cfg(feature = "net")))]
#[doc(inline)]
pub use net::ALPN;

#[cfg(feature = "net")]
#[cfg_attr(iroh_docsrs, doc(cfg(feature = "net")))]
pub use self::ticket::DocTicket;
pub use self::{heads::*, keys::*, sync::*};

0 comments on commit 6b05f0e

Please sign in to comment.