From 1cedb3727e6cd58c7500f7fcf47d05748a726cc6 Mon Sep 17 00:00:00 2001 From: Michael Rosenberg Date: Tue, 13 Dec 2022 02:29:45 -0500 Subject: [PATCH] Fixed docs build (#475) Also sets code font size in docs back to normal (no longer small) --- Makefile | 7 +++---- docs/assets/rustdoc-include-katex-header.html | 1 - src/backend/serial/fiat_u32/field.rs | 3 +++ src/backend/serial/fiat_u64/field.rs | 3 +++ src/backend/serial/u32/field.rs | 3 +++ src/backend/serial/u32/scalar.rs | 1 + src/backend/serial/u64/field.rs | 3 +++ src/backend/serial/u64/scalar.rs | 1 + 8 files changed, 17 insertions(+), 5 deletions(-) diff --git a/Makefile b/Makefile index 177c1cd..2eafcaa 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,7 @@ -FEATURES := simd_backend serde rand_core digest +FEATURES := serde rand_core digest doc: - cargo +nightly rustdoc --features "$(FEATURES)" -- --html-in-header docs/assets/rustdoc-include-katex-header.html --cfg docsrs + cargo +nightly rustdoc --features "$(FEATURES)" -- --html-in-header docs/assets/rustdoc-include-katex-header.html --cfg docsrs --cfg=curve25519_dalek_backend=\"simd\" doc-internal: - cargo +nightly rustdoc --features "$(FEATURES)" -- --html-in-header docs/assets/rustdoc-include-katex-header.html --document-private-items --cfg docsrs - + cargo +nightly rustdoc --features "$(FEATURES)" -- --html-in-header docs/assets/rustdoc-include-katex-header.html --document-private-items --cfg docsrs --cfg=curve25519_dalek_backend=\"simd\" diff --git a/docs/assets/rustdoc-include-katex-header.html b/docs/assets/rustdoc-include-katex-header.html index 1632563..d240432 100644 --- a/docs/assets/rustdoc-include-katex-header.html +++ b/docs/assets/rustdoc-include-katex-header.html @@ -9,5 +9,4 @@ diff --git a/src/backend/serial/fiat_u32/field.rs b/src/backend/serial/fiat_u32/field.rs index 3336e56..2bc2b14 100644 --- a/src/backend/serial/fiat_u32/field.rs +++ b/src/backend/serial/fiat_u32/field.rs @@ -177,8 +177,11 @@ impl ConditionallySelectable for FieldElement2625 { } impl FieldElement2625 { + /// The scalar \\( 0 \\). pub const ZERO: FieldElement2625 = FieldElement2625([0, 0, 0, 0, 0, 0, 0, 0, 0, 0]); + /// The scalar \\( 1 \\). pub const ONE: FieldElement2625 = FieldElement2625([1, 0, 0, 0, 0, 0, 0, 0, 0, 0]); + /// The scalar \\( -1 \\). pub const MINUS_ONE: FieldElement2625 = FieldElement2625([ 0x3ffffec, 0x1ffffff, 0x3ffffff, 0x1ffffff, 0x3ffffff, 0x1ffffff, 0x3ffffff, 0x1ffffff, 0x3ffffff, 0x1ffffff, diff --git a/src/backend/serial/fiat_u64/field.rs b/src/backend/serial/fiat_u64/field.rs index bc7d208..99402d3 100644 --- a/src/backend/serial/fiat_u64/field.rs +++ b/src/backend/serial/fiat_u64/field.rs @@ -156,8 +156,11 @@ impl ConditionallySelectable for FieldElement51 { } impl FieldElement51 { + /// The scalar \\( 0 \\). pub const ZERO: FieldElement51 = FieldElement51([0, 0, 0, 0, 0]); + /// The scalar \\( 1 \\). pub const ONE: FieldElement51 = FieldElement51([1, 0, 0, 0, 0]); + /// The scalar \\( -1 \\). pub const MINUS_ONE: FieldElement51 = FieldElement51([ 2251799813685228, 2251799813685247, diff --git a/src/backend/serial/u32/field.rs b/src/backend/serial/u32/field.rs index e0f24b3..3b6f16b 100644 --- a/src/backend/serial/u32/field.rs +++ b/src/backend/serial/u32/field.rs @@ -282,8 +282,11 @@ impl ConditionallySelectable for FieldElement2625 { } impl FieldElement2625 { + /// The scalar \\( 0 \\). pub const ZERO: FieldElement2625 = FieldElement2625([0, 0, 0, 0, 0, 0, 0, 0, 0, 0]); + /// The scalar \\( 1 \\). pub const ONE: FieldElement2625 = FieldElement2625([1, 0, 0, 0, 0, 0, 0, 0, 0, 0]); + /// The scalar \\( -1 \\). pub const MINUS_ONE: FieldElement2625 = FieldElement2625([ 0x3ffffec, 0x1ffffff, 0x3ffffff, 0x1ffffff, 0x3ffffff, 0x1ffffff, 0x3ffffff, 0x1ffffff, 0x3ffffff, 0x1ffffff, diff --git a/src/backend/serial/u32/scalar.rs b/src/backend/serial/u32/scalar.rs index 2c000a7..a677df3 100644 --- a/src/backend/serial/u32/scalar.rs +++ b/src/backend/serial/u32/scalar.rs @@ -53,6 +53,7 @@ fn m(x: u32, y: u32) -> u64 { } impl Scalar29 { + /// The scalar \\( 0 \\). pub const ZERO: Scalar29 = Scalar29([0, 0, 0, 0, 0, 0, 0, 0, 0]); /// Unpack a 32 byte / 256 bit scalar into 9 29-bit limbs. diff --git a/src/backend/serial/u64/field.rs b/src/backend/serial/u64/field.rs index 88e2388..afa506c 100644 --- a/src/backend/serial/u64/field.rs +++ b/src/backend/serial/u64/field.rs @@ -253,8 +253,11 @@ impl ConditionallySelectable for FieldElement51 { } impl FieldElement51 { + /// The scalar \\( 0 \\). pub const ZERO: FieldElement51 = FieldElement51([0, 0, 0, 0, 0]); + /// The scalar \\( 1 \\). pub const ONE: FieldElement51 = FieldElement51([1, 0, 0, 0, 0]); + /// The scalar \\( -1 \\). pub const MINUS_ONE: FieldElement51 = FieldElement51([ 2251799813685228, 2251799813685247, diff --git a/src/backend/serial/u64/scalar.rs b/src/backend/serial/u64/scalar.rs index dfdc19e..e05cf66 100644 --- a/src/backend/serial/u64/scalar.rs +++ b/src/backend/serial/u64/scalar.rs @@ -55,6 +55,7 @@ fn m(x: u64, y: u64) -> u128 { } impl Scalar52 { + /// The scalar \\( 0 \\). pub const ZERO: Scalar52 = Scalar52([0, 0, 0, 0, 0]); /// Unpack a 32 byte / 256 bit scalar into 5 52-bit limbs.