DOC: switch to KaTeX for math rendering

sfstoolbox · Feb 10, 2019 · 38e2c5c · 38e2c5c
1 parent 059410f
commit 38e2c5c
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 31 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -17,6 +17,11 @@
 import os
 from subprocess import check_output
 
+import sphinxcontrib.katex as katex
+
+sys.path.insert(0, os.path.abspath('.'))
+from math_definitions import latex_macros
+
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -32,7 +37,7 @@
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.mathjax',
+    'sphinxcontrib.katex',
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',  # support for NumPy-style docstrings
     'sphinx.ext.intersphinx',
@@ -149,6 +154,10 @@
 # If true, keep warnings as "system message" paragraphs in the built documents.
 #keep_warnings = False
 
+# Math settings
+katex_macros = katex.latex_defs_to_katex_macros(latex_macros)
+katex_options = 'macros: {' + katex_macros + '}'
+
 
 # -- Options for HTML output ----------------------------------------------
 
@@ -251,7 +260,7 @@ def setup(app):
 #'pointsize': '10pt',
 
 # Additional stuff for the LaTeX preamble.
-#'preamble': '',
+'preamble': latex_macros,
 
 'printindex': '',
 }

diff --git a/doc/math-definitions.rst b/doc/math-definitions.rst
diff --git a/doc/math_definitions.py b/doc/math_definitions.py
@@ -0,0 +1,10 @@
+latex_macros = r"""
+    \def \dirac      #1{\operatorname{\delta}\left(#1\right)}
+    \def \e          #1{\operatorname{e}^{#1}}
+    \def \Hankel     #3{\mathop{{}H_{#2}^{(#1)}}\!\left(#3\right)}
+    \def \hankel     #3{\mathop{{}h_{#2}^{(#1)}}\!\left(#3\right)}
+    \def \i            {\mathrm{i}}
+    \def \scalarprod #2{\left\langle#1,#2\right\rangle}
+    \def \vec        #1{\mathbf{#1}}
+    \def \wc           {\frac{\omega}{c}}
+"""
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -3,6 +3,7 @@ Sphinx-RTD-Theme
 nbsphinx
 ipykernel
 sphinxcontrib-bibtex
+sphinxcontrib-katex
 
 NumPy
 SciPy

diff --git a/sfs/mono/drivingfunction.py b/sfs/mono/drivingfunction.py
@@ -1,9 +1,4 @@
-"""Compute driving functions for various systems.
-
-.. include:: math-definitions.rst
-
-"""
-
+"""Compute driving functions for various systems."""
 import numpy as np
 from numpy.core.umath_tests import inner1d  # element-wise inner product
 from scipy.special import jn, hankel2

diff --git a/sfs/time/drivingfunction.py b/sfs/time/drivingfunction.py
@@ -1,8 +1,4 @@
-"""Compute time based driving functions for various systems.
-
-.. include:: math-definitions.rst
-
-"""
+"""Compute time based driving functions for various systems."""
 import numpy as np
 from numpy.core.umath_tests import inner1d  # element-wise inner product
 from .. import defs

diff --git a/sfs/time/source.py b/sfs/time/source.py
@@ -2,8 +2,6 @@
 
 The Green's function describes the spatial sound propagation over time.
 
-.. include:: math-definitions.rst
-
 """
 
 import numpy as np

diff --git a/sfs/util.py b/sfs/util.py
@@ -1,9 +1,4 @@
-"""Various utility functions.
-
-.. include:: math-definitions.rst
-
-"""
-
+"""Various utility functions."""
 import collections
 import numpy as np
 from scipy.special import spherical_jn, spherical_yn