Skip to content

Commit 73613ff

Browse files
authored
Merge pull request #652 from dhardy/doc
Switch documentation to rust-random.github.io and prepare 0.6.1
2 parents 5511699 + fdd78bc commit 73613ff

File tree

23 files changed

+84
-74
lines changed

23 files changed

+84
-74
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ A [separate changelog is kept for rand_core](rand_core/CHANGELOG.md).
99
You may also find the [Upgrade Guide](https://rust-random.github.io/book/update.html) useful.
1010

1111

12+
## [0.6.1] - 2018-11-22
13+
- Support sampling `Duration` also for `no_std` (only since Rust 1.25) (#649)
14+
- Disable default features of `libc` (#647)
15+
1216
## [0.6.0] - 2018-11-14
1317

1418
### Project organisation

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[package]
22
name = "rand"
3-
version = "0.6.0" # NB: When modifying, also modify html_root_url in lib.rs
3+
version = "0.6.1"
44
authors = ["The Rand Project Developers", "The Rust Project Developers"]
55
license = "MIT/Apache-2.0"
66
readme = "README.md"
77
repository = "https://github.com/rust-random/rand"
8-
documentation = "https://docs.rs/rand"
8+
documentation = "https://rust-random.github.io/rand"
99
homepage = "https://crates.io/crates/rand"
1010
description = """
1111
Random number generators and other randomness functionality.

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
[![Build Status](https://travis-ci.org/rust-random/rand.svg?branch=master)](https://travis-ci.org/rust-random/rand)
44
[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-random/rand?svg=true)](https://ci.appveyor.com/project/rust-random/rand)
5-
[![Latest version](https://img.shields.io/crates/v/rand.svg)](https://crates.io/crates/rand)
6-
[![Documentation](https://docs.rs/rand/badge.svg)](https://docs.rs/rand)
7-
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-yellow.svg)](https://github.com/rust-random/rand#rust-version-requirements)
8-
[![License](https://img.shields.io/crates/l/rand.svg)](https://github.com/rust-random/rand#license)
5+
[![Crate](https://img.shields.io/crates/v/rand.svg)](https://crates.io/crates/rand)
6+
[![Book](https://img.shields.io/badge/book-master-yellow.svg)](https://rust-random.github.io/book/)
7+
[![API](https://img.shields.io/badge/api-master-yellow.svg)](https://rust-random.github.io/rand)
8+
[![API](https://docs.rs/rand/badge.svg)](https://docs.rs/rand)
9+
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-lightgray.svg)](https://github.com/rust-random/rand#rust-version-requirements)
910

1011
A Rust library for random number generation.
1112

@@ -18,9 +19,9 @@ implementations should prefer to use `rand_core` while most other users should
1819
depend on `rand`.
1920

2021
Documentation:
21-
- [The Rust Rand Book](https://rust-random.github.io/book/)
22-
- [API reference for the latest release](https://docs.rs/rand/)
23-
- [API reference for the master branch](https://rust-random.github.io/rand/)
22+
- [The Rust Rand Book](https://rust-random.github.io/book)
23+
- [API reference (master)](https://rust-random.github.io/rand)
24+
- [API reference (docs.rs)](https://docs.rs/rand)
2425

2526

2627
## Usage
@@ -32,7 +33,7 @@ Add this to your `Cargo.toml`:
3233
rand = "0.6"
3334
```
3435

35-
To get started using Rand, see [The Book](https://rust-random.github.io/book/).
36+
To get started using Rand, see [The Book](https://rust-random.github.io/book).
3637

3738

3839
## Versions

rand_chacha/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[package]
22
name = "rand_chacha"
3-
version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs
3+
version = "0.1.0"
44
authors = ["The Rand Project Developers", "The Rust Project Developers"]
55
license = "MIT/Apache-2.0"
66
readme = "README.md"
77
repository = "https://github.com/rust-random/rand"
8-
documentation = "https://docs.rs/rand_chacha"
8+
documentation = "https://rust-random.github.io/rand/rand_chacha"
99
homepage = "https://crates.io/crates/rand_chacha"
1010
description = """
1111
ChaCha random number generator

rand_chacha/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
[![Build Status](https://travis-ci.org/rust-random/rand.svg)](https://travis-ci.org/rust-random/rand)
44
[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-random/rand?svg=true)](https://ci.appveyor.com/project/rust-random/rand)
55
[![Latest version](https://img.shields.io/crates/v/rand_chacha.svg)](https://crates.io/crates/rand_chacha)
6-
[![Documentation](https://docs.rs/rand_chacha/badge.svg)](https://docs.rs/rand_chacha)
7-
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-yellow.svg)](https://github.com/rust-random/rand#rust-version-requirements)
8-
[![License](https://img.shields.io/crates/l/rand_chacha.svg)](https://github.com/rust-random/rand/tree/master/rand_chacha#license)
6+
[![Book](https://img.shields.io/badge/book-master-yellow.svg)](https://rust-random.github.io/book/)
7+
[![API](https://img.shields.io/badge/api-master-yellow.svg)](https://rust-random.github.io/rand/rand_chacha)
8+
[![API](https://docs.rs/rand_chacha/badge.svg)](https://docs.rs/rand_chacha)
9+
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-lightgray.svg)](https://github.com/rust-random/rand#rust-version-requirements)
910

1011
A cryptographically secure random number generator that uses the ChaCha
1112
algorithm.
@@ -15,11 +16,11 @@ as an RNG. It is an improved variant of the Salsa20 cipher family, which was
1516
selected as one of the "stream ciphers suitable for widespread adoption" by
1617
eSTREAM[^2].
1718

18-
Documentation:
19-
[master branch](https://rust-random.github.io/rand/rand_chacha/index.html),
20-
[by release](https://docs.rs/rand_chacha)
19+
Links:
2120

22-
[Changelog](CHANGELOG.md)
21+
- [API documentation (master)](https://rust-random.github.io/rand/rand_chacha)
22+
- [API documentation (docs.rs)](https://docs.rs/rand_chacha)
23+
- [Changelog](CHANGELOG.md)
2324

2425
[rand]: https://crates.io/crates/rand
2526
[^1]: D. J. Bernstein, [*ChaCha, a variant of Salsa20*](

rand_chacha/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
1111
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
1212
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
13-
html_root_url = "https://docs.rs/rand_chacha/0.1.0")]
13+
html_root_url = "https://rust-random.github.io/rand/")]
1414

1515
#![deny(missing_docs)]
1616
#![deny(missing_debug_implementations)]

rand_core/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[package]
22
name = "rand_core"
3-
version = "0.3.0" # NB: When modifying, also modify html_root_url in lib.rs
3+
version = "0.3.0"
44
authors = ["The Rand Project Developers", "The Rust Project Developers"]
55
license = "MIT/Apache-2.0"
66
readme = "README.md"
77
repository = "https://github.com/rust-random/rand"
8-
documentation = "https://docs.rs/rand_core"
8+
documentation = "https://rust-random.github.io/rand/rand_core"
99
homepage = "https://crates.io/crates/rand_core"
1010
description = """
1111
Core random number generator traits and tools for implementation.

rand_core/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33
[![Build Status](https://travis-ci.org/rust-random/rand.svg)](https://travis-ci.org/rust-random/rand)
44
[![Build Status](https://ci.appveyor.com/api/projects/status/github/rust-random/rand?svg=true)](https://ci.appveyor.com/project/rust-random/rand)
55
[![Latest version](https://img.shields.io/crates/v/rand_core.svg)](https://crates.io/crates/rand_core)
6-
[![Documentation](https://docs.rs/rand_core/badge.svg)](https://docs.rs/rand_core)
7-
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-yellow.svg)](https://github.com/rust-random/rand#rust-version-requirements)
8-
[![License](https://img.shields.io/crates/l/rand_core.svg)](https://github.com/rust-random/rand/tree/master/rand_core#license)
6+
[![Book](https://img.shields.io/badge/book-master-yellow.svg)](https://rust-random.github.io/book/)
7+
[![API](https://img.shields.io/badge/api-master-yellow.svg)](https://rust-random.github.io/rand/rand_core)
8+
[![API](https://docs.rs/rand_core/badge.svg)](https://docs.rs/rand_core)
9+
[![Minimum rustc version](https://img.shields.io/badge/rustc-1.22+-lightgray.svg)](https://github.com/rust-random/rand#rust-version-requirements)
910

1011
Core traits and error types of the [rand] library, plus tools for implementing
1112
RNGs.
@@ -20,11 +21,11 @@ applications (including sampling from restricted ranges, conversion to floating
2021
point, list permutations and secure initialisation of RNGs). Most users should
2122
prefer to use the main [rand] crate.
2223

23-
Documentation:
24-
[master branch](https://rust-random.github.io/rand/rand_core/index.html),
25-
[by release](https://docs.rs/rand_core)
24+
Links:
2625

27-
[Changelog](CHANGELOG.md)
26+
- [API documentation (master)](https://rust-random.github.io/rand/rand_core)
27+
- [API documentation (docs.rs)](https://docs.rs/rand_core)
28+
- [Changelog](CHANGELOG.md)
2829

2930
[rand]: https://crates.io/crates/rand
3031

rand_core/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
3535
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk.png",
3636
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
37-
html_root_url = "https://docs.rs/rand_core/0.3.0")]
37+
html_root_url = "https://rust-random.github.io/rand/")]
3838

3939
#![deny(missing_docs)]
4040
#![deny(missing_debug_implementations)]

rand_hc/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
[package]
22
name = "rand_hc"
3-
version = "0.1.0" # NB: When modifying, also modify html_root_url in lib.rs
3+
version = "0.1.0"
44
authors = ["The Rand Project Developers"]
55
license = "MIT/Apache-2.0"
66
readme = "README.md"
77
repository = "https://github.com/rust-random/rand"
8-
documentation = "https://docs.rs/rand_hc"
8+
documentation = "https://rust-random.github.io/rand/rand_hc"
99
homepage = "https://crates.io/crates/rand_hc"
1010
description = """
1111
HC128 random number generator

0 commit comments

Comments
 (0)