Merge pull request #652 from dhardy/doc
Switch documentation to rust-random.github.io and prepare 0.6.1
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 21cc322..489df48 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,10 @@
You may also find the [Upgrade Guide](https://rust-random.github.io/book/update.html) useful.
+## [0.6.1] - 2018-11-22
+- Support sampling `Duration` also for `no_std` (only since Rust 1.25) (#649)
+- Disable default features of `libc` (#647)
+
## [0.6.0] - 2018-11-14
### Project organisation
diff --git a/Cargo.toml b/Cargo.toml
index 628e570..5f95c37 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,11 +1,11 @@
[package]
name = "rand"
-version = "0.6.0" # NB: When modifying, also modify html_root_url in lib.rs
+version = "0.6.1"
authors = ["The Rand Project Developers", "The Rust Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/rust-random/rand"
-documentation = "https://docs.rs/rand"
+documentation = "https://rust-random.github.io/rand"
homepage = "https://crates.io/crates/rand"
description = """
Random number generators and other randomness functionality.
diff --git a/README.md b/README.md
index 17714c4..95970af 100644
--- a/README.md
+++ b/README.md
@@ -2,10 +2,11 @@
[](https://travis-ci.org/rust-random/rand)
[](https://ci.appveyor.com/project/rust-random/rand)
-[](https://crates.io/crates/rand)
-[](https://docs.rs/rand)
-[](https://github.com/rust-random/rand#rust-version-requirements)
-[](https://github.com/rust-random/rand#license)
+[](https://crates.io/crates/rand)
+[](https://rust-random.github.io/book/)
+[](https://rust-random.github.io/rand)
+[](https://docs.rs/rand)
+[](https://github.com/rust-random/rand#rust-version-requirements)
A Rust library for random number generation.
@@ -18,9 +19,9 @@
depend on `rand`.
Documentation:
-- [The Rust Rand Book](https://rust-random.github.io/book/)
-- [API reference for the latest release](https://docs.rs/rand/)
-- [API reference for the master branch](https://rust-random.github.io/rand/)
+- [The Rust Rand Book](https://rust-random.github.io/book)
+- [API reference (master)](https://rust-random.github.io/rand)
+- [API reference (docs.rs)](https://docs.rs/rand)
## Usage
@@ -32,7 +33,7 @@
rand = "0.6"
```
-To get started using Rand, see [The Book](https://rust-random.github.io/book/).
+To get started using Rand, see [The Book](https://rust-random.github.io/book).
## Versions
diff --git a/rand_chacha/Cargo.toml b/rand_chacha/Cargo.toml
index 5629cfc..af70969 100644
--- a/rand_chacha/Cargo.toml
+++ b/rand_chacha/Cargo.toml
@@ -1,11 +1,11 @@
[package]
name = "rand_chacha"
-version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs
+version = "0.1.0"
authors = ["The Rand Project Developers", "The Rust Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/rust-random/rand"
-documentation = "https://docs.rs/rand_chacha"
+documentation = "https://rust-random.github.io/rand/rand_chacha"
homepage = "https://crates.io/crates/rand_chacha"
description = """
ChaCha random number generator
diff --git a/rand_chacha/README.md b/rand_chacha/README.md
index 30fede2..5a1dbac 100644
--- a/rand_chacha/README.md
+++ b/rand_chacha/README.md
@@ -3,9 +3,10 @@
[](https://travis-ci.org/rust-random/rand)
[](https://ci.appveyor.com/project/rust-random/rand)
[](https://crates.io/crates/rand_chacha)
-[](https://docs.rs/rand_chacha)
-[](https://github.com/rust-random/rand#rust-version-requirements)
-[](https://github.com/rust-random/rand/tree/master/rand_chacha#license)
+[](https://rust-random.github.io/book/)
+[](https://rust-random.github.io/rand/rand_chacha)
+[](https://docs.rs/rand_chacha)
+[](https://github.com/rust-random/rand#rust-version-requirements)
A cryptographically secure random number generator that uses the ChaCha
algorithm.
@@ -15,11 +16,11 @@
selected as one of the "stream ciphers suitable for widespread adoption" by
eSTREAM[^2].
-Documentation:
-[master branch](https://rust-random.github.io/rand/rand_chacha/index.html),
-[by release](https://docs.rs/rand_chacha)
+Links:
-[Changelog](CHANGELOG.md)
+- [API documentation (master)](https://rust-random.github.io/rand/rand_chacha)
+- [API documentation (docs.rs)](https://docs.rs/rand_chacha)
+- [Changelog](CHANGELOG.md)
[rand]: https://crates.io/crates/rand
[^1]: D. J. Bernstein, [*ChaCha, a variant of Salsa20*](
diff --git a/rand_chacha/src/lib.rs b/rand_chacha/src/lib.rs
index c473dce..8cff03a 100644
--- a/rand_chacha/src/lib.rs
+++ b/rand_chacha/src/lib.rs
@@ -10,7 +10,7 @@
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
- html_root_url = "https://docs.rs/rand_chacha/0.1.0")]
+ html_root_url = "https://rust-random.github.io/rand/")]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
diff --git a/rand_core/Cargo.toml b/rand_core/Cargo.toml
index 6f4e79f..1678773 100644
--- a/rand_core/Cargo.toml
+++ b/rand_core/Cargo.toml
@@ -1,11 +1,11 @@
[package]
name = "rand_core"
-version = "0.3.0" # NB: When modifying, also modify html_root_url in lib.rs
+version = "0.3.0"
authors = ["The Rand Project Developers", "The Rust Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/rust-random/rand"
-documentation = "https://docs.rs/rand_core"
+documentation = "https://rust-random.github.io/rand/rand_core"
homepage = "https://crates.io/crates/rand_core"
description = """
Core random number generator traits and tools for implementation.
diff --git a/rand_core/README.md b/rand_core/README.md
index d37a991..dee6504 100644
--- a/rand_core/README.md
+++ b/rand_core/README.md
@@ -3,9 +3,10 @@
[](https://travis-ci.org/rust-random/rand)
[](https://ci.appveyor.com/project/rust-random/rand)
[](https://crates.io/crates/rand_core)
-[](https://docs.rs/rand_core)
-[](https://github.com/rust-random/rand#rust-version-requirements)
-[](https://github.com/rust-random/rand/tree/master/rand_core#license)
+[](https://rust-random.github.io/book/)
+[](https://rust-random.github.io/rand/rand_core)
+[](https://docs.rs/rand_core)
+[](https://github.com/rust-random/rand#rust-version-requirements)
Core traits and error types of the [rand] library, plus tools for implementing
RNGs.
@@ -20,11 +21,11 @@
point, list permutations and secure initialisation of RNGs). Most users should
prefer to use the main [rand] crate.
-Documentation:
-[master branch](https://rust-random.github.io/rand/rand_core/index.html),
-[by release](https://docs.rs/rand_core)
+Links:
-[Changelog](CHANGELOG.md)
+- [API documentation (master)](https://rust-random.github.io/rand/rand_core)
+- [API documentation (docs.rs)](https://docs.rs/rand_core)
+- [Changelog](CHANGELOG.md)
[rand]: https://crates.io/crates/rand
diff --git a/rand_core/src/lib.rs b/rand_core/src/lib.rs
index 385d348..a65db93 100644
--- a/rand_core/src/lib.rs
+++ b/rand_core/src/lib.rs
@@ -34,7 +34,7 @@
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
- html_root_url = "https://docs.rs/rand_core/0.3.0")]
+ html_root_url = "https://rust-random.github.io/rand/")]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
diff --git a/rand_hc/Cargo.toml b/rand_hc/Cargo.toml
index 7e08bf4..ed5dd5b 100644
--- a/rand_hc/Cargo.toml
+++ b/rand_hc/Cargo.toml
@@ -1,11 +1,11 @@
[package]
name = "rand_hc"
-version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs
+version = "0.1.0"
authors = ["The Rand Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/rust-random/rand"
-documentation = "https://docs.rs/rand_hc"
+documentation = "https://rust-random.github.io/rand/rand_hc"
homepage = "https://crates.io/crates/rand_hc"
description = """
HC128 random number generator
diff --git a/rand_hc/README.md b/rand_hc/README.md
index 9c1f5e1..178548a 100644
--- a/rand_hc/README.md
+++ b/rand_hc/README.md
@@ -3,9 +3,10 @@
[](https://travis-ci.org/rust-random/rand)
[](https://ci.appveyor.com/project/rust-random/rand)
[](https://crates.io/crates/rand_hc)
-[](https://docs.rs/rand_hc)
-[](https://github.com/rust-random/rand#rust-version-requirements)
-[](https://github.com/rust-random/rand/tree/master/rand_hc#license)
+[[](https://rust-random.github.io/book/)
+[](https://rust-random.github.io/rand/rand_hc)
+[](https://docs.rs/rand_hc)
+[](https://github.com/rust-random/rand#rust-version-requirements)
A cryptographically secure random number generator that uses the HC-128
algorithm.
@@ -14,11 +15,11 @@
RNG. It is selected as one of the "stream ciphers suitable for widespread
adoption" by eSTREAM[^2].
-Documentation:
-[master branch](https://rust-random.github.io/rand/rand_hc/index.html),
-[by release](https://docs.rs/rand_hc)
+Links:
-[Changelog](CHANGELOG.md)
+- [API documentation (master)](https://rust-random.github.io/rand/rand_hc)
+- [API documentation (docs.rs)](https://docs.rs/rand_hc)
+- [Changelog](CHANGELOG.md)
[rand]: https://crates.io/crates/rand
[^1]: Hongjun Wu (2008). ["The Stream Cipher HC-128"](
diff --git a/rand_hc/src/lib.rs b/rand_hc/src/lib.rs
index 15ca34e..f1d772d 100644
--- a/rand_hc/src/lib.rs
+++ b/rand_hc/src/lib.rs
@@ -10,7 +10,7 @@
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
- html_root_url = "https://docs.rs/rand_hc/0.1.0")]
+ html_root_url = "https://rust-random.github.io/rand/")]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
diff --git a/rand_isaac/Cargo.toml b/rand_isaac/Cargo.toml
index 676df96..07c4a36 100644
--- a/rand_isaac/Cargo.toml
+++ b/rand_isaac/Cargo.toml
@@ -1,11 +1,11 @@
[package]
name = "rand_isaac"
-version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs
+version = "0.1.0"
authors = ["The Rand Project Developers", "The Rust Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/rust-random/rand"
-documentation = "https://docs.rs/rand_isaac"
+documentation = "https://rust-random.github.io/rand/rand_isaac"
homepage = "https://crates.io/crates/rand_isaac"
description = """
ISAAC random number generator
diff --git a/rand_isaac/README.md b/rand_isaac/README.md
index ec8758a..02d1230 100644
--- a/rand_isaac/README.md
+++ b/rand_isaac/README.md
@@ -3,9 +3,10 @@
[](https://travis-ci.org/rust-random/rand)
[](https://ci.appveyor.com/project/rust-random/rand)
[](https://crates.io/crates/rand_isaac)
-[](https://docs.rs/rand_isaac)
-[](https://github.com/rust-random/rand#rust-version-requirements)
-[](https://github.com/rust-random/rand/tree/master/rand_isaac#license)
+[](https://rust-random.github.io/book/)
+[](https://rust-random.github.io/rand/rand_isaac)
+[](https://docs.rs/rand_isaac)
+[](https://github.com/rust-random/rand#rust-version-requirements)
Implements the ISAAC and ISAAC-64 random number generators.
@@ -17,14 +18,13 @@
ISAAC is notably fast and produces excellent quality random numbers for
non-cryptographic applications.
-Documentation:
-[master branch](https://rust-random.github.io/rand/rand_isaac/index.html),
-[by release](https://docs.rs/rand_isaac)
+Links:
-[Changelog](CHANGELOG.md)
+- [API documentation (master)](https://rust-random.github.io/rand/rand_isaac)
+- [API documentation (docs.rs)](https://docs.rs/rand_isaac)
+- [Changelog](CHANGELOG.md)
[rand]: https://crates.io/crates/rand
-
[^1]: Bob Jenkins, [*ISAAC: A fast cryptographic random number generator*](http://burtleburtle.net/bob/rand/isaacafa.html)
[^2]: Bob Jenkins, [*ISAAC and RC4*](http://burtleburtle.net/bob/rand/isaac.html)
diff --git a/rand_isaac/src/lib.rs b/rand_isaac/src/lib.rs
index fe70124..ec82d8e 100644
--- a/rand_isaac/src/lib.rs
+++ b/rand_isaac/src/lib.rs
@@ -10,7 +10,7 @@
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
- html_root_url = "https://docs.rs/rand_isaac/0.1.0")]
+ html_root_url = "https://rust-random.github.io/rand/")]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
diff --git a/rand_pcg/Cargo.toml b/rand_pcg/Cargo.toml
index ee35d8f..c8a29fc 100644
--- a/rand_pcg/Cargo.toml
+++ b/rand_pcg/Cargo.toml
@@ -1,11 +1,11 @@
[package]
name = "rand_pcg"
-version = "0.1.1" # NB: When modifying, also modify html_root_url in lib.rs
+version = "0.1.1"
authors = ["The Rand Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/rust-random/rand"
-documentation = "https://docs.rs/rand_pcg"
+documentation = "https://rust-random.github.io/rand/rand_pcg"
homepage = "https://crates.io/crates/rand_pcg"
description = """
Selected PCG random number generators
diff --git a/rand_pcg/README.md b/rand_pcg/README.md
index 2b682a4..4599813 100644
--- a/rand_pcg/README.md
+++ b/rand_pcg/README.md
@@ -3,9 +3,10 @@
[](https://travis-ci.org/rust-random/rand)
[](https://ci.appveyor.com/project/rust-random/rand)
[](https://crates.io/crates/rand_pcg)
-[](https://docs.rs/rand_pcg)
-[](https://github.com/rust-random/rand#rust-version-requirements)
-[](https://github.com/rust-random/rand/tree/master/rand_pcg#license)
+[[](https://rust-random.github.io/book/)
+[](https://rust-random.github.io/rand/rand_pcg)
+[](https://docs.rs/rand_pcg)
+[](https://github.com/rust-random/rand#rust-version-requirements)
Implements a selection of PCG random number generators.
@@ -19,11 +20,11 @@
This crate depends on [rand_core](https://crates.io/crates/rand_core) and is
part of the [Rand project](https://github.com/rust-random/rand).
-Documentation:
-[master branch](https://rust-random.github.io/rand/rand_pcg/index.html),
-[by release](https://docs.rs/rand_pcg)
+Links:
-[Changelog](CHANGELOG.md)
+- [API documentation (master)](https://rust-random.github.io/rand/rand_pcg)
+- [API documentation (docs.rs)](https://docs.rs/rand_pcg)
+- [Changelog](CHANGELOG.md)
## Crate Features
diff --git a/rand_pcg/src/lib.rs b/rand_pcg/src/lib.rs
index e699c4e..5160e87 100644
--- a/rand_pcg/src/lib.rs
+++ b/rand_pcg/src/lib.rs
@@ -29,7 +29,7 @@
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
- html_root_url = "https://docs.rs/rand_pcg/0.1.1")]
+ html_root_url = "https://rust-random.github.io/rand/")]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
diff --git a/rand_xorshift/Cargo.toml b/rand_xorshift/Cargo.toml
index d38d1d5..b763bfc 100644
--- a/rand_xorshift/Cargo.toml
+++ b/rand_xorshift/Cargo.toml
@@ -1,11 +1,11 @@
[package]
name = "rand_xorshift"
-version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs
+version = "0.1.0"
authors = ["The Rand Project Developers", "The Rust Project Developers"]
license = "MIT/Apache-2.0"
readme = "README.md"
repository = "https://github.com/rust-random/rand"
-documentation = "https://docs.rs/rand_xorshift"
+documentation = "https://rust-random.github.io/rand/rand_xorshift"
homepage = "https://crates.io/crates/rand_xorshift"
description = """
Xorshift random number generator
diff --git a/rand_xorshift/README.md b/rand_xorshift/README.md
index 97f64fb..573ee12 100644
--- a/rand_xorshift/README.md
+++ b/rand_xorshift/README.md
@@ -3,9 +3,10 @@
[](https://travis-ci.org/rust-random/rand)
[](https://ci.appveyor.com/project/rust-random/rand)
[](https://crates.io/crates/rand_xorshift)
-[](https://docs.rs/rand_xorshift)
-[](https://github.com/rust-random/rand#rust-version-requirements)
-[](https://github.com/rust-random/rand/tree/master/rand_xorshift#license)
+[](https://rust-random.github.io/book/)
+[](https://rust-random.github.io/rand/rand_xorshift)
+[](https://docs.rs/rand_xorshift)
+[](https://github.com/rust-random/rand#rust-version-requirements)
Implements the Xorshift random number generator.
@@ -17,11 +18,11 @@
["Xorshift RNGs"](https://www.jstatsoft.org/v08/i14/paper).
*Journal of Statistical Software*. Vol. 8 (Issue 14).
-Documentation:
-[master branch](https://rust-random.github.io/rand/rand_xorshift/index.html),
-[by release](https://docs.rs/rand_xorshift)
+Links:
-[Changelog](CHANGELOG.md)
+- [API documentation (master)](https://rust-random.github.io/rand/rand_xorshift)
+- [API documentation (docs.rs)](https://docs.rs/rand_xorshift)
+- [Changelog](CHANGELOG.md)
[rand]: https://crates.io/crates/rand
diff --git a/rand_xorshift/src/lib.rs b/rand_xorshift/src/lib.rs
index 1e74c3a..aad74e4 100644
--- a/rand_xorshift/src/lib.rs
+++ b/rand_xorshift/src/lib.rs
@@ -10,7 +10,7 @@
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
- html_root_url = "https://docs.rs/rand_xorshift/0.1.0")]
+ html_root_url = "https://rust-random.github.io/rand/")]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
diff --git a/src/lib.rs b/src/lib.rs
index 8f1d1d1..d364bd1 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -49,7 +49,7 @@
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
- html_root_url = "https://docs.rs/rand/0.6.0")]
+ html_root_url = "https://rust-random.github.io/rand/")]
#![deny(missing_docs)]
#![deny(missing_debug_implementations)]
diff --git a/src/rngs/small.rs b/src/rngs/small.rs
index c7b28fc..e74a83e 100644
--- a/src/rngs/small.rs
+++ b/src/rngs/small.rs
@@ -67,8 +67,8 @@
/// [`FromEntropy`]: ../trait.FromEntropy.html
/// [`StdRng`]: struct.StdRng.html
/// [`thread_rng`]: ../fn.thread_rng.html
-/// [`Pcg64Mcg`]: https://docs.rs/rand_pcg/0.1.0/rand_pcg/type.Pcg64Mcg.html
-/// [`Pcg32`]: https://docs.rs/rand_pcg/0.1.0/rand_pcg/type.Pcg32.html
+/// [`Pcg64Mcg`]: ../../rand_pcg/type.Pcg64Mcg.html
+/// [`Pcg32`]: ../../rand_pcg/type.Pcg32.html
#[derive(Clone, Debug)]
pub struct SmallRng(Rng);
