From 70f06338f95056b6d14fcd2ef0f1f82dc21b54bd Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Wed, 21 Feb 2018 11:01:59 -0800 Subject: [PATCH 1/5] Remove docs.rs docs.rs won't be the authoritative source for docs any more. Also, it won't build our docs properly, because the nightly Rust it uses is too old to support stuff like markdown-included-in-docs :( --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f7ad37d..66c61ba 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# curve25519-dalek [![](https://img.shields.io/crates/v/curve25519-dalek.svg)](https://crates.io/crates/curve25519-dalek) [![](https://docs.rs/curve25519-dalek/badge.svg)](https://docs.rs/curve25519-dalek) [![](https://travis-ci.org/dalek-cryptography/curve25519-dalek.svg?branch=master)](https://travis-ci.org/dalek-cryptography/curve25519-dalek) +# curve25519-dalek [![](https://img.shields.io/crates/v/curve25519-dalek.svg)](https://crates.io/crates/curve25519-dalek) [![](https://travis-ci.org/dalek-cryptography/curve25519-dalek.svg?branch=master)](https://travis-ci.org/dalek-cryptography/curve25519-dalek) Date: Wed, 21 Feb 2018 11:03:18 -0800 Subject: [PATCH 2/5] Load resources from our own domain --- README.md | 2 +- rustdoc-include-katex-header.html | 6 +++--- src/lib.rs | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 66c61ba..62afe30 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ + src="https://doc.dalek.rs/assets/dalek-logo-clear.png"/> **A pure-Rust implementation of group operations on Ristretto and Curve25519.** diff --git a/rustdoc-include-katex-header.html b/rustdoc-include-katex-header.html index 455a58e..bc4e3d8 100644 --- a/rustdoc-include-katex-header.html +++ b/rustdoc-include-katex-header.html @@ -1,6 +1,6 @@ - - - + + + diff --git a/src/lib.rs b/src/lib.rs index e06c1c6..5e9c854 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -24,7 +24,7 @@ #![cfg_attr(feature = "nightly", deny(missing_docs))] #![cfg_attr(feature = "nightly", doc(include = "../README.md"))] -#![doc(html_logo_url = "https://github.com/dalek-cryptography/curve25519-dalek/blob/develop/dalek-logo-clear.png?raw=true")] +#![doc(html_logo_url = "https://doc.dalek.rs/assets/dalek-logo-clear.png")] //------------------------------------------------------------------------ // External dependencies: From 3969d80c89e5a0fa387570c0c92aef61215b565c Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Wed, 21 Feb 2018 11:11:17 -0800 Subject: [PATCH 3/5] Add links to dalek.rs --- README.md | 2 ++ src/ristretto.rs | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 62afe30..f0d940d 100644 --- a/README.md +++ b/README.md @@ -118,3 +118,5 @@ contributions. [ed25519-dalek]: https://github.com/dalek-cryptography/ed25519-dalek [x25519-dalek]: https://github.com/dalek-cryptography/x25519-dalek [contributing]: https://github.com/dalek-cryptography/curve25519-dalek/blob/master/CONTRIBUTING.md +[docs-external]: https://doc.dalek.rs/curve25519_dalek/ +[docs-internal]: https://doc-internal.dalek.rs/curve25519_dalek/ diff --git a/src/ristretto.rs b/src/ristretto.rs index 6c30121..d92bbdd 100644 --- a/src/ristretto.rs +++ b/src/ristretto.rs @@ -129,7 +129,7 @@ //! gives the _Ristretto_ encoding. //! //! Notes on the details of the encoding can be found in the -//! `ristretto::notes` submodule of the internal `curve25519-dalek` +//! [`ristretto::notes`][ristretto_notes] submodule of the internal `curve25519-dalek` //! documentation. //! //! [cryptonote]: @@ -138,6 +138,8 @@ //! https://moderncrypto.org/mail-archive/curves/2017/000858.html //! [ristretto_coffee]: //! https://en.wikipedia.org/wiki/Ristretto +//! [ristretto_notes]: +//! https://doc-internal.dalek.rs/curve25519_dalek/ristretto/notes/index.html mod notes { From a271ff907de2c0219e43ddafa70a537833c6366f Mon Sep 17 00:00:00 2001 From: Henry de Valence Date: Thu, 22 Feb 2018 15:37:16 -0800 Subject: [PATCH 4/5] add link to curve models docs --- src/edwards.rs | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/edwards.rs b/src/edwards.rs index 4a4914e..9f28eb6 100644 --- a/src/edwards.rs +++ b/src/edwards.rs @@ -68,7 +68,8 @@ //! The Edwards arithmetic is implemented using the “extended twisted //! coordinates” of Hisil, Wong, Carter, and Dawson, and the //! corresponding complete formulas. For more details, -//! see the `curve_models` submodule of the internal documentation. +//! see the [`curve_models` submodule][curve_models] +//! of the internal documentation. //! //! ## Validity Checking //! @@ -80,6 +81,8 @@ //! unrepresentable: `EdwardsPoint` objects can only be created via //! successful decompression of a compressed point, or else by //! operations on other (valid) `EdwardsPoint`s. +//! +//! [curve_models]: https://doc-internal.dalek.rs/curve25519_dalek/curve_models/index.html // We allow non snake_case names because coordinates in projective space are // traditionally denoted by the capitalisation of their respective From c2be44749ff8e4cc98dbc4411ff1a70689fa414d Mon Sep 17 00:00:00 2001 From: Isis Lovecruft Date: Fri, 9 Mar 2018 23:59:20 +0000 Subject: [PATCH 5/5] Add a custom docs badge. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f0d940d..1ac09aa 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# curve25519-dalek [![](https://img.shields.io/crates/v/curve25519-dalek.svg)](https://crates.io/crates/curve25519-dalek) [![](https://travis-ci.org/dalek-cryptography/curve25519-dalek.svg?branch=master)](https://travis-ci.org/dalek-cryptography/curve25519-dalek) +# curve25519-dalek [![](https://img.shields.io/crates/v/curve25519-dalek.svg)](https://crates.io/crates/curve25519-dalek) [![](https://img.shields.io/badge/dynamic/json.svg?label=docs&uri=https%3A%2F%2Fcrates.io%2Fapi%2Fv1%2Fcrates%2Fcurve25519-dalek%2Fversions&query=%24.versions%5B0%5D.num&colorB=4F74A6)](https://doc.dalek.rs) [![](https://travis-ci.org/dalek-cryptography/curve25519-dalek.svg?branch=master)](https://travis-ci.org/dalek-cryptography/curve25519-dalek)