Merge pull request #325 from NREL/sphinx

Bump sphinx to 4.5.0
NREL · May 17, 2022 · f97a870 · f97a870
2 parents a5eeffb + e81058b
commit f97a870
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 3 deletions.
diff --git a/docs/sphinx/source/changelog/pending.rst b/docs/sphinx/source/changelog/pending.rst
@@ -11,5 +11,5 @@ Requirements
 * Bump ``ipython==7.16.3``, ``jupyter-console==6.4.0``,
   and ``prompt-toolkit==3.0.27`` in ``docs/notebook_requirements.txt``
   and bump ``Pillow==9.0.0`` in ``requirements.txt`` (:pull:`314`)
-* Bump ``nbsphinx`` version from 0.8.5 to 0.8.8 in the optional
-  ``[doc]`` requirements (:pull:`317`)
+* Bump ``sphinx`` version from 3.2 to 4.5 and ``nbsphinx`` version
+  from 0.8.5 to 0.8.8 in the optional ``[doc]`` requirements (:pull:`317`, :pull:`325`)
diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py
@@ -108,6 +108,21 @@ def setup(app):
     app.add_css_file("no_scrollbars.css")
 
 
+# Custom mathjax settings to get plotly graphs working in the notebook gallery
+# https://github.com/sphinx-doc/sphinx/issues/9563
+# https://github.com/spatialaudio/nbsphinx/issues/572#issuecomment-853389268
+# https://github.com/plotly/plotly.py/issues/3152#issuecomment-855432931
+
+mathjax_path = 'https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js?config=TeX-AMS-MML_HTMLorMML'
+mathjax2_config = {
+    'tex2jax': {
+        'inlineMath': [['$', '$'], ['\\(', '\\)']],
+        'processEscapes': True,
+        'ignoreClass': 'document',
+        'processClass': 'math|output_area',
+    }
+}
+
 # %% helper functions for intelligent "View on Github" linking
 # based on
 # https://gist.github.com/flying-sheep/b65875c0ce965fbdd1d9e5d0b9851ef1

diff --git a/setup.py b/setup.py
@@ -55,7 +55,7 @@
 
 EXTRAS_REQUIRE = {
     'doc': [
-        'sphinx==3.2',
+        'sphinx==4.5.0',
         'nbsphinx==0.8.8',
         'nbsphinx-link==1.3.0',
         'sphinx_rtd_theme==0.5.2',