Skip to content

Commit b15e3e6

Browse files
authored
enable dollarmath (#235)
+ fix some eqs
1 parent 5eab3b5 commit b15e3e6

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

docs/source/conf.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
'sphinx.ext.inheritance_diagram',
4545
'sphinx.ext.graphviz',
4646
'sphinx_copybutton',
47+
'sphinx_math_dollar',
4748
'sphinx-prompt',
4849
'IPython.sphinxext.ipython_console_highlighting',
4950
'sphinx.ext.githubpages']
@@ -104,6 +105,15 @@
104105
# If true, `todo` and `todoList` produce output, else they produce nothing.
105106
todo_include_todos = False
106107

108+
# -- Options for MathJax
109+
# for sphinx-math-dollar
110+
mathjax3_config = {}
111+
112+
mathjax3_config["tex"] = {
113+
"inlineMath": [['\\(', '\\)']],
114+
"displayMath": [["\\[", "\\]"]],
115+
}
116+
107117

108118
# -- Options for HTML output ----------------------------------------------
109119

docs/source/multigrid.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ There are three solvers:
1414

1515
* The class :func:`variable_coeff_MG.VarCoeffCCMG2d <pyro.multigrid.variable_coeff_MG.VarCoeffCCMG2d>` solves variable coefficient Poisson problems of the form
1616

17-
$$\nabla \cdot (\eta \nabla \phi ) = f`$$
17+
$$\nabla \cdot (\eta \nabla \phi ) = f$$
1818

1919
This class inherits the core functionality from ``MG.CellCenterMG2d``.
2020

2121
* The class :func:`general_MG.GeneralMG2d <pyro.multigrid.general_MG.GeneralMG2d>` solves a general elliptic
2222
equation of the form
2323

24-
$$`\alpha \phi + \nabla \cdot ( \beta \nabla \phi) + \gamma \cdot \nabla \phi = f`$$
24+
$$`\alpha \phi + \nabla \cdot ( \beta \nabla \phi) + \gamma \cdot \nabla \phi = f$$
2525

2626
This class inherits
2727
the core functionality from :func:`MG.CellCenterMG2d <pyro.multigrid.MG.CellCenterMG2d>`.

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ flake8>=3.5.0
1111
numba>=0.40.0
1212
numpydoc
1313
sphinxcontrib-bibtex
14+
sphinx-math-dollar
1415
sphinx-copybutton
1516
sphinx-prompt
1617
importlib-metadata

0 commit comments

Comments
 (0)