diff --git a/README.md b/README.md index f7ad37d..1ac09aa 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ -# 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://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) + src="https://doc.dalek.rs/assets/dalek-logo-clear.png"/> **A pure-Rust implementation of group operations on Ristretto and Curve25519.** @@ -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/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/edwards.rs b/src/edwards.rs index 2fd7c1e..952399d 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 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: diff --git a/src/ristretto.rs b/src/ristretto.rs index c809dbf..fa9ef68 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 {