Skip to content

Commit 74d791e

Browse files
authored
Use math notation in array rules docs (#290)
* Bump required version of Documenter * Add macros from physics package * Use Re and Im * Use tr * Remove wayward comma * Number equations correctly * Engage inline equation syntax * Use ip * Remove conj * Use asterisk for conjugate * Link to LU rule blog post As recommended by @nickrobinson251 in JuliaDiff/ChainRules.jl#354 (comment) * Use inner product everywhere * Use mathrm * Use inner product in more places * Add Sylvester equation example * Use mathsf for (conjugate) transpose * Add missing sign * Clarify language
1 parent 1be1a05 commit 74d791e

2 files changed

Lines changed: 16 additions & 2 deletions

File tree

docs/Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
66
Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
77

88
[compat]
9-
Documenter = "0.25"
9+
Documenter = "0.25.2"
1010
DocumenterTools = "0.1.6"

docs/make.jl

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,21 @@ makedocs(
2626
format=Documenter.HTML(
2727
prettyurls=false,
2828
assets=["assets/chainrules.css"],
29-
mathengine=MathJax(),
29+
mathengine=MathJax3(
30+
Dict(
31+
:tex => Dict(
32+
"inlineMath" => [["\$","\$"], ["\\(","\\)"]],
33+
"tags" => "ams",
34+
# TODO: remove when using physics package
35+
"macros" => Dict(
36+
"ip" => ["{\\left\\langle #1, #2 \\right\\rangle}", 2],
37+
"Re" => "{\\operatorname{Re}}",
38+
"Im" => "{\\operatorname{Im}}",
39+
"tr" => "{\\operatorname{tr}}",
40+
),
41+
),
42+
),
43+
),
3044
),
3145
sitename="ChainRules",
3246
authors="Jarrett Revels and other contributors",

0 commit comments

Comments
 (0)