Render mathematical expressions in documentation with mathjax (#97)

* Mathjax in docs

* Added source of Javascripts

* Removed odd whitespaces

Author: pnkraemer

docs/javascripts/mathjax.js

@@ -0,0 +1,18 @@
+// Taken from:
+// https://squidfunk.github.io/mkdocs-material/reference/mathjax/#docsjavascriptsmathjaxjs
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};
+
+document$.subscribe(() => {
+  MathJax.typesetPromise()
+})

matfree/hutch.py

@@ -22,7 +22,16 @@ def quadform(vec):
 
 
 def frobeniusnorm_squared(matvec_fun, /, **kwargs):
-    """Estimate the squared Frobenius norm of a matrix stochastically."""
+    r"""Estimate the squared Frobenius norm of a matrix stochastically.
+
+    The Frobenius norm of a matrix $A$ is defined as
+
+    $$
+    \|A\|_F^2 = \text{trace}(A^\top A)
+    $$
+
+    so computing squared Frobenius norms amounts to trace estimation.
+    """
 
     def quadform(vec):
         Av = matvec_fun(vec)

mkdocs.yml

@@ -53,4 +53,12 @@ extra:
       name: Nico
   generator: false
 copyright: Copyright © 2023 Nicholas Krämer
-markdown_extensions: [pymdownx.superfences]
+markdown_extensions:
+  - pymdownx.superfences
+  - pymdownx.arithmatex:
+      generic: true
+extra_javascript:
+  # From: https://squidfunk.github.io/mkdocs-material/reference/mathjax/#mkdocsyml
+  - javascripts/mathjax.js
+  - https://polyfill.io/v3/polyfill.min.js?features=es6
+  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js