Skip to content

Use docs.rs as default documentation #1895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2019
Merged

Use docs.rs as default documentation #1895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
</p>

<p align="center">
<a href="https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures/">
<a href="https://docs.rs/futures-preview/">
Documentation
</a> | <a href="https://rust-lang-nursery.github.io/futures-rs/">
Website
Expand Down
2 changes: 1 addition & 1 deletion futures-channel/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Alex Crichton <[email protected]>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_channel"
documentation = "https://docs.rs/futures-channel-preview/0.3.0-alpha.19"
description = """
Channels for asynchronous communication using futures-rs.
"""
Expand Down
2 changes: 1 addition & 1 deletion futures-channel/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_channel")]
#![doc(html_root_url = "https://docs.rs/futures-channel-preview/0.3.0-alpha.19")]

#[cfg(all(feature = "cfg-target-has-atomic", not(feature = "unstable")))]
compile_error!("The `cfg-target-has-atomic` feature requires the `unstable` feature as an explicit opt-in to unstable features");
Expand Down
2 changes: 1 addition & 1 deletion futures-core/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Alex Crichton <[email protected]>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_core"
documentation = "https://docs.rs/futures-core-preview/0.3.0-alpha.19"
description = """
The core traits and types in for the `futures` library.
"""
Expand Down
2 changes: 1 addition & 1 deletion futures-core/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_core")]
#![doc(html_root_url = "https://docs.rs/futures-core-preview/0.3.0-alpha.19")]

#[cfg(all(feature = "cfg-target-has-atomic", not(feature = "unstable")))]
compile_error!("The `cfg-target-has-atomic` feature requires the `unstable` feature as an explicit opt-in to unstable features");
Expand Down
2 changes: 1 addition & 1 deletion futures-executor/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Alex Crichton <[email protected]>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_executor"
documentation = "https://docs.rs/futures-executor-preview/0.3.0-alpha.19"
description = """
Executors for asynchronous tasks based on the futures-rs library.
"""
Expand Down
2 changes: 1 addition & 1 deletion futures-executor/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_executor")]
#![doc(html_root_url = "https://docs.rs/futures-executor-preview/0.3.0-alpha.19")]

#[cfg(feature = "std")]
mod local_pool;
Expand Down
2 changes: 1 addition & 1 deletion futures-io/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Alex Crichton <[email protected]>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_io"
documentation = "https://docs.rs/futures-io-preview/0.3.0-alpha.19"
description = """
The `AsyncRead` and `AsyncWrite` traits for the futures-rs library.
"""
Expand Down
2 changes: 1 addition & 1 deletion futures-io/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_io")]
#![doc(html_root_url = "https://docs.rs/futures-io-preview/0.3.0-alpha.19")]

#[cfg(all(feature = "read_initializer", not(feature = "unstable")))]
compile_error!("The `read_initializer` feature requires the `unstable` feature as an explicit opt-in to unstable features");
Expand Down
2 changes: 1 addition & 1 deletion futures-join-macro/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Taiki Endo <[email protected]>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_join_macro"
documentation = "https://docs.rs/futures-join-macro-preview/0.3.0-alpha.19"
description = """
Definition of the `join!` macro and the `try_join!` macro.
"""
Expand Down
4 changes: 4 additions & 0 deletions futures-join-macro/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
#![cfg_attr(test, warn(single_use_lifetimes))]
#![warn(clippy::all)]

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://docs.rs/futures-join-macro-preview/0.3.0-alpha.19")]

extern crate proc_macro;

use proc_macro::TokenStream;
Expand Down
2 changes: 1 addition & 1 deletion futures-select-macro/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Taylor Cramer <[email protected]>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_select_macro"
documentation = "https://docs.rs/futures-select-macro-preview/0.3.0-alpha.19"
description = """
The `select!` macro for waiting on multiple different `Future`s at once and handling the first one to complete.
"""
Expand Down
4 changes: 4 additions & 0 deletions futures-select-macro/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
#![cfg_attr(test, warn(single_use_lifetimes))]
#![warn(clippy::all)]

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://docs.rs/futures-select-macro-preview/0.3.0-alpha.19")]

extern crate proc_macro;

use proc_macro::TokenStream;
Expand Down
2 changes: 1 addition & 1 deletion futures-sink/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Alex Crichton <[email protected]>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_sink"
documentation = "https://docs.rs/futures-sink-preview/0.3.0-alpha.19"
description = """
The asynchronous `Sink` trait for the futures-rs library.
"""
Expand Down
2 changes: 1 addition & 1 deletion futures-sink/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_sink")]
#![doc(html_root_url = "https://docs.rs/futures-sink-preview/0.3.0-alpha.19")]

#[cfg(feature = "alloc")]
extern crate alloc;
Expand Down
2 changes: 1 addition & 1 deletion futures-test/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Wim Looman <[email protected]>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-doc/0.3.0-alpha.12/futures_test"
documentation = "https://docs.rs/futures-test-preview/0.3.0-alpha.19"
description = """
Common utilities for testing components built off futures-rs.
"""
Expand Down
2 changes: 1 addition & 1 deletion futures-test/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_test")]
#![doc(html_root_url = "https://docs.rs/futures-test-preview/0.3.0-alpha.19")]

#[cfg(not(feature = "std"))]
compile_error!("`futures-test` must have the `std` feature activated, this is a default-active feature");
Expand Down
2 changes: 1 addition & 1 deletion futures-util/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ authors = ["Alex Crichton <[email protected]>"]
license = "MIT OR Apache-2.0"
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_util"
documentation = "https://docs.rs/futures-util-preview/0.3.0-alpha.19"
description = """
Common utilities and extension traits for the futures-rs library.
"""
Expand Down
2 changes: 1 addition & 1 deletion futures-util/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures_util")]
#![doc(html_root_url = "https://docs.rs/futures-util-preview/0.3.0-alpha.19")]

#[cfg(all(feature = "cfg-target-has-atomic", not(feature = "unstable")))]
compile_error!("The `cfg-target-has-atomic` feature requires the `unstable` feature as an explicit opt-in to unstable features");
Expand Down
2 changes: 1 addition & 1 deletion futures/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ readme = "../README.md"
keywords = ["futures", "async", "future"]
repository = "https://github.com/rust-lang-nursery/futures-rs"
homepage = "https://rust-lang-nursery.github.io/futures-rs"
documentation = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures"
documentation = "https://docs.rs/futures-preview/0.3.0-alpha.19"
description = """
An implementation of futures and streams featuring zero allocations,
composability, and iterator-like interfaces.
Expand Down
2 changes: 1 addition & 1 deletion futures/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

#![doc(test(attr(deny(warnings), allow(dead_code, unused_assignments, unused_variables))))]

#![doc(html_root_url = "https://rust-lang-nursery.github.io/futures-api-docs/0.3.0-alpha.19/futures")]
#![doc(html_root_url = "https://docs.rs/futures-preview/0.3.0-alpha.19")]

#[cfg(all(feature = "cfg-target-has-atomic", not(feature = "unstable")))]
compile_error!("The `cfg-target-has-atomic` feature requires the `unstable` feature as an explicit opt-in to unstable features");
Expand Down