From 7b4547f51da519194bcecaa99efcb1462bb8b16c Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Fri, 25 Mar 2022 13:27:13 -0400 Subject: [PATCH 1/4] bump sphinx and pydata-sphinx-theme versions --- setup.py | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index 7dc779a16c..7faaf6a9dc 100755 --- a/setup.py +++ b/setup.py @@ -53,8 +53,11 @@ 'optional': ['cython', 'ephem', 'netcdf4', 'nrel-pysam', 'numba', 'pvfactors', 'siphon', 'statsmodels', 'cftime >= 1.1.1'], - 'doc': ['ipython', 'matplotlib', 'sphinx == 3.1.2', - 'pydata-sphinx-theme == 0.8.0', 'sphinx-gallery', + # sphinx 4.4.0 has an annoying, difficult-to-disable, warning about + # extlinks: https://github.com/sphinx-doc/sphinx/issues/10112 + # So stick with <4.4.0 for now. + 'doc': ['ipython', 'matplotlib', 'sphinx == 4.3.2', + 'pydata-sphinx-theme == 0.8.1', 'sphinx-gallery', 'docutils == 0.15.2', 'pillow', 'netcdf4', 'siphon', 'sphinx-toggleprompt >= 0.0.5', 'pvfactors'], 'test': TESTS_REQUIRE From 9fa50fc8975846fff03f269aad50d0579aee4aa4 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Fri, 25 Mar 2022 13:27:26 -0400 Subject: [PATCH 2/4] clean up sphinx conf.py --- docs/sphinx/source/conf.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index 9826781d6d..07fe84dc76 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -244,7 +244,7 @@ def setup(app): # In-line links to references as numbers in brackets. app.add_css_file("reference_format.css") # Add a warning banner at the top of the page if viewing the "latest" docs - app.add_javascript("version-alert.js") + app.add_js_file("version-alert.js") # -- Options for LaTeX output --------------------------------------------- @@ -343,8 +343,6 @@ def setup(app): 'matplotlib': ('https://matplotlib.org/stable', None), } -nbsphinx_allow_errors = True - ipython_warning_is_error = False # suppress "WARNING: Footnote [1] is not referenced." messages From 76972a8ba21389383a94f2d940cbe963cd40c461 Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Fri, 25 Mar 2022 13:48:38 -0400 Subject: [PATCH 3/4] fix distutils strangeness, maybe --- 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 07fe84dc76..fb5228c332 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -20,6 +20,9 @@ # for generating GH links with linenumbers import inspect +# import distutils before calling pd.show_versions() +# https://github.com/pypa/setuptools/issues/3044 +import distutils # noqa: F401 import pandas as pd pd.show_versions() From f16f7327c728eb6e1383c895335b78446377d72f Mon Sep 17 00:00:00 2001 From: Kevin Anderson Date: Mon, 28 Mar 2022 09:01:38 -0400 Subject: [PATCH 4/4] use freshly-released sphinx==4.5.0 --- setup.py | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/setup.py b/setup.py index 7faaf6a9dc..892f23579c 100755 --- a/setup.py +++ b/setup.py @@ -53,10 +53,7 @@ 'optional': ['cython', 'ephem', 'netcdf4', 'nrel-pysam', 'numba', 'pvfactors', 'siphon', 'statsmodels', 'cftime >= 1.1.1'], - # sphinx 4.4.0 has an annoying, difficult-to-disable, warning about - # extlinks: https://github.com/sphinx-doc/sphinx/issues/10112 - # So stick with <4.4.0 for now. - 'doc': ['ipython', 'matplotlib', 'sphinx == 4.3.2', + 'doc': ['ipython', 'matplotlib', 'sphinx == 4.5.0', 'pydata-sphinx-theme == 0.8.1', 'sphinx-gallery', 'docutils == 0.15.2', 'pillow', 'netcdf4', 'siphon', 'sphinx-toggleprompt >= 0.0.5', 'pvfactors'],