From 0c5e52eea312171bcae2c5ff7a919e80cf150bc5 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Tue, 8 Feb 2022 17:17:31 -0500 Subject: [PATCH 1/2] Update SciPy doc reference path As noted in https://github.com/scipy/scipy/issues/15545 the object inventory has moved. Though there's a redirect, it has paths like `reference/..` which doubles the `reference` in the URL. --- doc/conf.py | 4 ++-- doc/devel/documenting_mpl.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 7d5e729c8a20..3b8b51d83394 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -160,7 +160,7 @@ def _check_dependencies(): 'pandas': ('https://pandas.pydata.org/pandas-docs/stable/', None), 'pytest': ('https://pytest.org/en/stable/', None), 'python': ('https://docs.python.org/3/', None), - 'scipy': ('https://docs.scipy.org/doc/scipy/reference/', None), + 'scipy': ('https://docs.scipy.org/doc/scipy/', None), 'tornado': ('https://www.tornadoweb.org/en/stable/', None), 'xarray': ('https://xarray.pydata.org/en/stable/', None), } @@ -191,7 +191,7 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf, 'reference_url': { 'matplotlib': None, 'numpy': 'https://numpy.org/doc/stable/', - 'scipy': 'https://docs.scipy.org/doc/scipy/reference/', + 'scipy': 'https://docs.scipy.org/doc/scipy/', }, 'backreferences_dir': Path('api') / Path('_as_gen'), 'subsection_order': gallery_order.sectionorder, diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst index e95d60a1c5b1..356b223717d5 100644 --- a/doc/devel/documenting_mpl.rst +++ b/doc/devel/documenting_mpl.rst @@ -307,7 +307,7 @@ commands:: python -m sphinx.ext.intersphinx 'https://docs.python.org/3/objects.inv' python -m sphinx.ext.intersphinx 'https://numpy.org/doc/stable/objects.inv' - python -m sphinx.ext.intersphinx 'https://docs.scipy.org/doc/scipy/reference/objects.inv' + python -m sphinx.ext.intersphinx 'https://docs.scipy.org/doc/scipy/objects.inv' python -m sphinx.ext.intersphinx 'https://pandas.pydata.org/pandas-docs/stable/objects.inv' .. _rst-figures-and-includes: From 062e34392ce5f1ab8f13442277f5e9b084f66b47 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Tue, 8 Feb 2022 19:37:23 -0500 Subject: [PATCH 2/2] Simplify sphinx-gallery intersphinx config According to its docs, there's no need for any additional entries in `reference_url` if intersphinx is being used. --- doc/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 3b8b51d83394..a3542e43050b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -190,8 +190,6 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf, 'doc_module': ('matplotlib', 'mpl_toolkits'), 'reference_url': { 'matplotlib': None, - 'numpy': 'https://numpy.org/doc/stable/', - 'scipy': 'https://docs.scipy.org/doc/scipy/', }, 'backreferences_dir': Path('api') / Path('_as_gen'), 'subsection_order': gallery_order.sectionorder,