From 5eaa760f84fc2a08bb9211b0528959236d9f3548 Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Tue, 21 May 2024 11:54:46 -0700 Subject: [PATCH 1/4] add mathjax config to conf.py --- docs/sphinx/source/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 93c1e63527..225d9d0a19 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -56,6 +56,9 @@ 'sphinx_toggleprompt', ] +mathjax_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. From 3ab0e0312786920b0ecfc91ec688e7a1cac45ec4 Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Tue, 21 May 2024 12:38:21 -0700 Subject: [PATCH 2/4] mathjax3 --- docs/sphinx/source/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 225d9d0a19..9c0d90990e 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -56,8 +56,8 @@ 'sphinx_toggleprompt', ] -mathjax_config = {'chtml': {'displayAlign': 'left', - 'displayIndent': '2em'}} +mathjax3_config = {'chtml': {'displayAlign': 'left', + 'displayIndent': '2em'}} napoleon_use_rtype = False # group rtype on same line together with return From 64f2bcebd2019718f6beae4f7f2b50efdb44f036 Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Tue, 21 May 2024 13:36:11 -0700 Subject: [PATCH 3/4] whatsnew --- docs/sphinx/source/whatsnew/v0.10.5.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx/source/whatsnew/v0.10.5.rst b/docs/sphinx/source/whatsnew/v0.10.5.rst index 00daed3a0f..7336e8096a 100644 --- a/docs/sphinx/source/whatsnew/v0.10.5.rst +++ b/docs/sphinx/source/whatsnew/v0.10.5.rst @@ -23,7 +23,7 @@ Documentation * Fix variable name typo at ``docs\examples\system-models\plot_oedi_9068.py``. (:pull:`1996`) * Remove "Comparison with PVLib for Matlab" page from the User Guide. (:issue:`2010`, :pull:`2012`) - +* Configure mathjax to left-align and indent equations in docstrings. (:pull:`2056`) Requirements ~~~~~~~~~~~~ From ae9687f192fd14317da419200065987060eb768c Mon Sep 17 00:00:00 2001 From: Cliff Hansen Date: Tue, 21 May 2024 13:40:13 -0700 Subject: [PATCH 4/4] v0.11 whatsnew --- docs/sphinx/source/whatsnew/v0.10.5.rst | 2 +- docs/sphinx/source/whatsnew/v0.11.0.rst | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/sphinx/source/whatsnew/v0.10.5.rst b/docs/sphinx/source/whatsnew/v0.10.5.rst index 7336e8096a..00daed3a0f 100644 --- a/docs/sphinx/source/whatsnew/v0.10.5.rst +++ b/docs/sphinx/source/whatsnew/v0.10.5.rst @@ -23,7 +23,7 @@ Documentation * Fix variable name typo at ``docs\examples\system-models\plot_oedi_9068.py``. (:pull:`1996`) * Remove "Comparison with PVLib for Matlab" page from the User Guide. (:issue:`2010`, :pull:`2012`) -* Configure mathjax to left-align and indent equations in docstrings. (:pull:`2056`) + Requirements ~~~~~~~~~~~~ diff --git a/docs/sphinx/source/whatsnew/v0.11.0.rst b/docs/sphinx/source/whatsnew/v0.11.0.rst index 7ea847a6d9..142974ea78 100644 --- a/docs/sphinx/source/whatsnew/v0.11.0.rst +++ b/docs/sphinx/source/whatsnew/v0.11.0.rst @@ -27,7 +27,7 @@ Testing Documentation ~~~~~~~~~~~~~ - +* Configure mathjax to left-align and indent equations in docstrings. (:pull:`2056`) Requirements ~~~~~~~~~~~~ @@ -35,3 +35,4 @@ Requirements Contributors ~~~~~~~~~~~~ +* Cliff Hansen (:ghuser:`cwhanse`)