Add configuration options for math mode (#2056)

cwhanse · web-flow · commit 60110b450616 · 2024-05-22T10:54:45.000-04:00
* add mathjax config to conf.py

* mathjax3

* whatsnew

* v0.11 whatsnew
diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py
@@ -56,6 +56,9 @@
     'sphinx_toggleprompt',
 ]
 
+mathjax3_config = {'chtml': {'displayAlign': 'left',
+                             'displayIndent': '2em'}}
+
 napoleon_use_rtype = False  # group rtype on same line together with return
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/docs/sphinx/source/whatsnew/v0.11.0.rst b/docs/sphinx/source/whatsnew/v0.11.0.rst
@@ -27,11 +27,12 @@ Testing
 
 Documentation
 ~~~~~~~~~~~~~
-
+* Configure mathjax to left-align and indent equations in docstrings. (:pull:`2056`)
 
 Requirements
 ~~~~~~~~~~~~
 
 
 Contributors
 ~~~~~~~~~~~~
+* Cliff Hansen (:ghuser:`cwhanse`)

Original file line number	Diff line number	Diff line change
`@@ -56,6 +56,9 @@`
`56`	`56`	`'sphinx_toggleprompt',`
`57`	`57`	`]`
`58`	`58`
	`59`	`+mathjax3_config = {'chtml': {'displayAlign': 'left',`
	`60`	`+ 'displayIndent': '2em'}}`
	`61`	`+`
`59`	`62`	`napoleon_use_rtype = False # group rtype on same line together with return`
`60`	`63`
`61`	`64`	`# Add any paths that contain templates here, relative to this directory.`