Merge pull request #138 from jorenham/katex

Author: jorenham

.dprint.jsonc

@@ -13,14 +13,26 @@
   "markdown": {
     "emphasisKind": "asterisks",
   },
+  "markup": {
+    "printWidth": 100,
+    "preferAttrsSingleLine": false,
+  },
   "yaml": {
     "formatComments": true,
     "braceSpacing": false,
   },
+  "typescript": {
+    "semiColons": "asi",
+    "quoteProps": "consistent",
+    "spaceSurroundingProperties": false,
+    "preferSingleLine": true,
+  },
   "plugins": [
+    "https://plugins.dprint.dev/g-plane/markup_fmt-v0.24.0.wasm",
     "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.1.wasm",
-    "https://plugins.dprint.dev/json-0.20.0.wasm",
-    "https://plugins.dprint.dev/markdown-0.19.0.wasm",
+    "https://plugins.dprint.dev/json-0.21.0.wasm",
+    "https://plugins.dprint.dev/markdown-0.20.0.wasm",
     "https://plugins.dprint.dev/toml-0.7.0.wasm",
+    "https://plugins.dprint.dev/typescript-0.95.12.wasm",
   ],
 }

Cargo.toml

@@ -4,14 +4,17 @@ version = "0.3.3+0.1.3"
 authors = ["Joren Hammudoglu <[email protected]>"]
 categories = ["api-bindings", "mathematics", "science"]
 edition = "2024"
-include = ["*.rs", "xsf/include"]
+include = ["*.rs", "xsf/include", "katex.html"]
 keywords = ["ffi", "bindings", "math", "xsf", "scipy"]
 license = "BSD-3-Clause"
 readme = "README.md"
 repository = "https://github.com/jorenham/xsf-rust"
 rust-version = "1.85.1"
 description = "Bindings for SciPy special functions"
 
+[package.metadata.docs.rs]
+rustdoc-args = ["--html-in-header", "katex.html"]
+
 [dependencies]
 num-complex = "0.4.6"
 num-traits = "0.2.19"

Makefile

@@ -0,0 +1,2 @@
+doc:
+	RUSTDOCFLAGS="--html-in-header katex.html" cargo +nightly doc --all-features --no-deps

katex.html

@@ -0,0 +1,74 @@
+<link
+  rel="stylesheet"
+  href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css"
+  integrity="sha384-WcoG4HRXMzYzfCgiyfrySxx90XSl2rxY5mnVY5TwtWE6KLrArNKn0T/mOgNL0Mmi"
+  crossorigin="anonymous"
+>
+<script
+  src="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.js"
+  integrity="sha384-J+9dG2KMoiR9hqcFao0IBLwxt6zpcyN68IgwzsCSkbreXUjmNVRhPFTssqdSGjwQ"
+  crossorigin="anonymous"
+>
+</script>
+<script
+  src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/auto-render.min.js"
+  integrity="sha384-hCXGrW6PitJEwbkoStFjeJxv+fSOOQKOPbJxSfM6G5sWZjAyWhXiTIIAmQqnlLlh"
+  crossorigin="anonymous"
+>
+</script>
+<script
+  src="https://cdn.jsdelivr.net/npm/[email protected]/dist/contrib/copy-tex.min.js"
+  integrity="sha384-HORx6nWi8j5/mYA+y57/9/CZc5z8HnEw4WUZWy5yOn9ToKBv1l58vJaufFAn9Zzi"
+  crossorigin="anonymous"
+>
+</script>
+
+<script>
+document.addEventListener("DOMContentLoaded", () => {
+  renderMathInElement(document.body, {
+    strict: "error",
+    throwOnError: true,
+    trust: true,
+    delimiters: [{left: "$$", right: "$$", display: true}, {left: "$", right: "$", display: false}],
+    macros: {
+      // Beta function
+      "\\B": "\\mathop{\\Beta}",
+
+      // error function
+      "\\erf": "\\mathop{\\mathrm{erf}}",
+      "\\erfc": "\\mathop{\\mathrm{erfc}}",
+      "\\erfi": "\\mathop{\\mathrm{erfi}}",
+
+      // sign function
+      "\\sgn": "\\mathop{\\mathrm{sgn}}",
+
+      // kelvin functions
+      "\\ber": "\\mathop{\\mathrm{ber}}",
+      "\\berp": "\\mathop{\\mathrm{ber}'}",
+      "\\bei": "\\mathop{\\mathrm{bei}}",
+      "\\beip": "\\mathop{\\mathrm{bei}'}",
+      "\\ker": "\\mathop{\\mathrm{ker}}",
+      "\\kerp": "\\mathop{\\mathrm{ker}'}",
+      "\\kei": "\\mathop{\\mathrm{kei}}",
+      "\\keip": "\\mathop{\\mathrm{kei}'}",
+
+      // sine and cosine integrals
+      "\\Si": "\\mathop{\\mathrm{Si}}",
+      "\\Ci": "\\mathop{\\mathrm{Ci}}",
+      "\\Shi": "\\mathop{\\mathrm{Shi}}",
+      "\\Chi": "\\mathop{\\mathrm{Chi}}",
+
+      // falling and rising factorials
+      "\\fpow": "#1^{\\overline{#2}}",
+      "\\rpow": "#1^{\\underline{#2}}",
+
+      // some missing "physics" tex package commands
+      "\\dd": "\\,\\mathrm{d}{#1}",
+    },
+  })
+})
+</script>
+
+<style>
+.docblock > p { overflow-y: hidden }
+</style>