Various intersphinx mappings

intersphinx_mappings.txt

# The entries in this file are checked regularly for validity via the Github Action
# sited at github.com/bskinn/intersphinx-gist.
# Please feel free to post an issue at that repo if any of these mappings don't work for you,
# or if you're having trouble constructing a mapping for a project not listed here.

Python 3 [latest]: ('https://docs.python.org/3/', None)
Python 3 [3.x]: ('https://docs.python.org/3.9/', None)
attrs [stable]: ('https://www.attrs.org/en/stable/', None)
Django [dev]: ('https://docs.djangoproject.com/en/dev/', 'https://docs.djangoproject.com/en/dev/_objects/')
Flask [2.2.x]: ('https://flask.palletsprojects.com/en/2.2.x/', None)
Flask [1.1.x]: ('https://flask.palletsprojects.com/en/1.1.x/', None)
h5py [latest]: ('https://docs.h5py.org/en/latest/', None)
matplotlib [stable]: ('https://matplotlib.org/stable/', None)
numpy [stable]: ('https://numpy.org/doc/stable/', None)
pandas [latest?]: ('https://pandas.pydata.org/docs/', None)
Pyramid [latest]: ('https://docs.pylonsproject.org/projects/pyramid/en/latest/', None)
scikit-learn [stable]: ('https://scikit-learn.org/stable/', None)
Sphinx [master]: ('https://www.sphinx-doc.org/en/master/', None)
sympy [latest]: ('https://docs.sympy.org/latest/', None)


# Because of occasional historical complexity to SciPy's docs,
# I'm breaking it out separately.
#
# The form shown for v1.8.1 is expected to work for all versions
# from v1.7.0 onward. The additional versions v1.7.1 and v1.8.0 are
# included here for robustness of testing.
#
# The previous idiosyncratic entry for v1.8.0 is no longer needed now that the
# docs hosting config has been fixed, see github.com/scipy/scipy/issues/14267
# and issues/PRs linked therein.
#
# The form shown for v1.6.3 should work for all versions back to at least v1.3.0;
# just replace the version number in the URL.
#
scipy [latest]: ('https://docs.scipy.org/doc/scipy/', None)
scipy [1.8.1]: ('https://docs.scipy.org/doc/scipy-1.8.1/', None)
scipy [1.8.0]: ('https://docs.scipy.org/doc/scipy-1.8.0/', None)
scipy [1.7.1]: ('https://docs.scipy.org/doc/scipy-1.7.1/', None)
scipy [1.7.0]: ('https://docs.scipy.org/doc/scipy-1.7.0/', None)
scipy [1.6.3]: ('https://docs.scipy.org/doc/scipy-1.6.3/reference/', None)


# This should be a good template for most any docs hosted on RtD.
sarge [latest]: ('https://sarge.readthedocs.io/en/latest/', None)

Very useful. Thanks.

numpy at least is now on https.

Good point, @bmerry. All updated.

It also looks like numpy docs have moved - when I used the current intersphinx mapping it took me to a page that said I wasn't viewing the latest docs. It's now https://numpy.org/doc/stable.

@bmerry, quite right, looks like they've restructured how they have the docs hosted. Updated as you indicated!

Matplotlib canonical docs have moved to https://matplotlib.og/stable (https://discourse.matplotlib.org/t/canonical-documentation-have-moved/21863)

Fixed -- thanks, @jklymak!

Wow, fast! But this list does come up quite high in google search, so your help in spreading the word is very much appreciated!

Oh, wow, really @jklymak? Yikes, I'd better be more proactive about making sure these are all fresh...

Yeah, I searched on "intersphinx matplotlib" and it is the first thing under the stack overflow answers ;-)

Hi there, it looks like the scipy file has recently moved up one directory level. Removing "reference/" worked for me.

Hey @rcomer! Indeed, it looks like scipy reorganized their docs, as you noted. Fixed, thanks for reporting the change!

Something is up with the SciPy docs a/o 6 Feb 2022... Either they've restructured or something is broken. Will update here as I know more.

@bskinn I think they are working on it - see scipy/docs.scipy.org#60

@rcomer Looks like they've been working on it for quite a while: scipy/scipy#14267

I don't at all envy them the challenge of maintaining multiple current and historical versions of docs that have had to be restructured multiple times over the project history.

I might need to split SciPy out here by (minor?) version, depending on the solution they settle on.

SciPy now split out by version range. Three epochs: (i) 1.3.0 (and earlier?) to 1.6.3, (ii) 1.7.x, and (iii) the current 1.8.0.

If the 1.8.0 mapping changes further, I'll update it here. My GH Action to check links is set to run once every three days, so I might not catch it immediately now set to run every twelve hours, so I should catch it pretty quickly.

I often find it difficult to know exactly how to reference a particular object, so I often do:

python -m sphinx.ext.intersphinx https://pandas.pydata.org/docs/objects.inv > objects.inv

And then grep through the output to figure out if e.g. I should use :attr: or :meth:

@ConstantinoSchillebeeckx Yep, that's definitely a good way to pull out that info.

Another way is my project sphobjinv, using the suggest CLI tool, e.g.:

$ pip install sphobjinv
$ sphobjinv suggest -su https://pandas.pydata.org/docs/objects.inv dataframe

They both give the same information, just presented differently.

SciPy mappings updated after the team's fix to the docs hosting setup.

Hi! Probably worth adding Jax? They deploy just the latest version to RTD, though: https://jax.readthedocs.io/en/latest/

Heya, @agriyakhetarpal! Thanks for the suggestion, but I don't plan to put any more RTD examples into the gist, seeing as how any RTD mapping entries are going to usually follow the same template as the sarge listing that's already there.

On checking, it looks like Matthias already has Jax in Labs' intersphinx_registry, so that's good.