Merge pull request #372 from NNPDF/swap-katex

Swap KaTeX from local to global
NNPDF · May 17, 2024 · 3c86e0e · 3c86e0e
2 parents 628ddd9 + a5eb840
commit 3c86e0e
Show file tree

Hide file tree

Showing 12 changed files with 72 additions and 680 deletions.
diff --git a/crates/Cargo.lock b/crates/Cargo.lock
diff --git a/crates/eko/Cargo.toml b/crates/eko/Cargo.toml
@@ -3,11 +3,13 @@ name = "eko"
 version = "0.1.0"
 edition = "2021"
 
+[package.metadata.docs.rs]
+rustdoc-args = [ "--html-in-header", "../katex-header.html" ]
+
 [lib]
 name = "ekors"
 crate-type = ["cdylib"]
 
 [dependencies]
 num = "0.4.1"
-katexit = "0.1.4"
 ekore = { version = "0.1.0", path = "../ekore" }
diff --git a/crates/eko/src/mellin.rs b/crates/eko/src/mellin.rs
@@ -6,7 +6,6 @@
 use num::complex::Complex;
 use std::f64::consts::PI;
 
-#[cfg_attr(doc, katexit::katexit)]
 /// Talbot inversion path.
 ///
 /// Implements the algorithm presented in [\[Abate\]](crate::bib::Abate).

diff --git a/crates/ekore/Cargo.toml b/crates/ekore/Cargo.toml
@@ -5,10 +5,12 @@ edition = "2021"
 description = "EKO expressions"
 license = "GPL-3.0-or-later"
 
+[package.metadata.docs.rs]
+rustdoc-args = [ "--html-in-header", "../katex-header.html" ]
+
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
 num = "0.4.1"
 float-cmp = "0.9.0"
-katexit = "0.1.4"
 hashbrown = "0.14"
diff --git a/crates/ekore/src/constants.rs b/crates/ekore/src/constants.rs
@@ -1,24 +1,20 @@
 //! Global constants.
 
-#[cfg_attr(doc, katexit::katexit)]
 /// The number of colors.
 ///
 /// Defaults to $N_C = 3$.
 pub const NC: u8 = 3;
 
-#[cfg_attr(doc, katexit::katexit)]
 /// The normalization of fundamental generators.
 ///
 /// Defaults to $T_R = 1/2$.
 pub const TR: f64 = 1.0 / 2.0;
 
-#[cfg_attr(doc, katexit::katexit)]
 /// Second Casimir constant in the adjoint representation.
 ///
 /// Defaults to $C_A = N_C = 3$.
 pub const CA: f64 = NC as f64;
 
-#[cfg_attr(doc, katexit::katexit)]
 /// Second Casimir constant in the fundamental representation.
 ///
 /// Defaults to $C_F = \frac{N_C^2-1}{2N_C} = 4/3$.

diff --git a/crates/ekore/src/harmonics/cache.rs b/crates/ekore/src/harmonics/cache.rs
@@ -5,7 +5,6 @@ use num::complex::Complex;
 
 use crate::harmonics::w1;
 
-#[cfg_attr(doc, katexit::katexit)]
 /// List of available elements.
 #[derive(Debug, PartialEq, Eq, Hash)]
 pub enum K {

diff --git a/crates/ekore/src/harmonics/polygamma.rs b/crates/ekore/src/harmonics/polygamma.rs
@@ -3,7 +3,6 @@
 use num::{complex::Complex, Zero};
 use std::f64::consts::PI;
 
-#[cfg_attr(doc, katexit::katexit)]
 /// Compute the polygamma functions $\psi_k(z)$.
 ///
 /// Reimplementation of ``WPSIPG`` (C317) in [CERNlib](http://cernlib.web.cern.ch/cernlib/) given by [[KOLBIG1972221]][crate::bib::KOLBIG1972221].

diff --git a/crates/katex-header.html b/crates/katex-header.html
@@ -0,0 +1,19 @@
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-wcIxkf4k558AjM3Yz3BBFQUbk/zgIYC2R0QpeeYb+TwlBVMrlgLqwRjRtGZiK7ww" crossorigin="anonymous">
+<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js" integrity="sha384-hIoBPJpTUs74ddyc4bFZSM1TVlQDA60VBbJS0oA934VSz82sBx1X7kSx2ATBDIyd" crossorigin="anonymous"></script>
+<script defer src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js" integrity="sha384-43gviWU0YVjaDtb/GhzOouOXtZMP/7XUzwPTstBeZFe/+rCMvRwr4yROQP43s0Xk" crossorigin="anonymous"></script>
+<script>
+    document.addEventListener("DOMContentLoaded", function() {
+        renderMathInElement(document.body, {
+          // customised options
+          // • auto-render specific keys, e.g.:
+          delimiters: [
+              {left: '$$', right: '$$', display: true},
+              {left: '$', right: '$', display: false},
+              {left: '\\(', right: '\\)', display: false},
+              {left: '\\[', right: '\\]', display: true}
+          ],
+          // • rendering keys, e.g.:
+          throwOnError : false
+        });
+    });
+</script>
diff --git a/pyproject.toml.patch b/pyproject.toml.patch
@@ -1,5 +1,5 @@
 diff --git a/pyproject.toml b/pyproject.toml
-index 31be6cb0..b4ec7c95 100644
+index 7404d871..a1e3ae66 100644
 --- a/pyproject.toml
 +++ b/pyproject.toml
 @@ -1,6 +1,20 @@
@@ -25,12 +25,13 @@ index 31be6cb0..b4ec7c95 100644
 
  [tool.poetry]
  name = "eko"
-@@ -124,6 +138,11 @@ asv-publish = "asv publish --config benchmarks/asv.conf.json"
+@@ -124,6 +138,12 @@ asv-publish = "asv publish --config benchmarks/asv.conf.json"
  asv-show = "asv show --config benchmarks/asv.conf.json"
  asv-clean = { "shell" = "rm -rf benchmarks/env benchmarks/html benchmarks/results" }
  asv = ["asv-run", "asv-publish", "asv-preview"]
 +compile = "pip install -e crates/eko/"
-+rdocs = "cargo doc --workspace --manifest-path crates/Cargo.toml --no-deps"
++rdocs.cmd = "cargo doc --workspace --manifest-path crates/Cargo.toml --no-deps"
++rdocs.env = { RUSTDOCFLAGS = "--html-in-header katex-header.html" }
 +rdocs-view = "xdg-open crates/target/doc/ekors/index.html"
 +rdocs-clean = "rm -rf crates/target/doc/"
 +rtest = "cargo test --workspace --manifest-path crates/Cargo.toml"

diff --git a/rustify.sh b/rustify.sh
@@ -1,5 +1,9 @@
 #!/usr/bin/bash
 
+# git diff --merge-base master pyproject.toml > pyproject.toml.patch
 patch -p1 <pyproject.toml.patch
+
+# git diff --merge-base master src/eko/evolution_operator/__init__.py > src/eko/evolution_operator/__init__.py.patch
 patch -p1 <src/eko/evolution_operator/__init__.py.patch
-patch -p1 <tests/eko/evolution_operator/test_init.py.patch
+
+mv tests/eko/evolution_operator/test_init.py tests/eko/evolution_operator/deactivated_t_e_s_t_init.py