intersphinx-registry 0.2405.27__py2.py3-none-any.whl

intersphinx_registry/__init__.py

@@ -0,0 +1,50 @@
+"""
+This package provides convenient utilities and data to write a sphinx config file.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+import json
+from typing import Dict, Tuple, Set, Optional, cast
+
+# See issue 4, we this the best format is Major.YYMM.day,
+# in case of multiple releases a day we can borrow the next day's date.
+__version__ = "0.2405.27"
+
+registry_file = Path(__file__).parent / "registry.json"
+
+def _get_all_mappings() ->  Dict[str, Tuple[str, Optional[str]]]:
+    return cast(
+        Dict[str, Tuple[str, Optional[str]]],
+        {k: tuple(v) for (k, v) in json.loads(registry_file.read_bytes()).items()},
+    )
+
+
+def get_intersphinx_mapping(
+    *, packages: Set[str] = set()
+) -> Dict[str, Tuple[str, Optional[str]]]:
+    """
+    Return values of intersphinx_mapping for sphinx configuration.
+
+    For convenience, the returned dictionary is a copy so should be ok to
+    mutate.
+
+    Parameters
+    ----------
+    packages: Set of Str
+        Libraries to include.
+
+        Sphinx will download and load all the `objects.inv` for listed 
+        packages. Getting all mappings is discourage as it will download all
+        the `object.inv` which can be a non-negligible amount of data.
+
+    """
+    if len(packages) == 0:
+        raise ValueError('You must explicitly give a list of packages for which to download intersphinx inventories: get_intersphinx_mapping(packages=["IPython", "numpy",...]).')
+
+    mapping = _get_all_mappings()
+    missing = set(packages) - set(mapping)
+    if missing:
+        raise ValueError(f"Some libraries in 'packages' not found in registry: {repr(sorted(missing))}")
+    return {k: v for k, v in mapping.items() if k in packages}

intersphinx_registry/registry.json

@@ -0,0 +1,167 @@
+{
+  "pillow": ["https://pillow.readthedocs.io/en/stable/", null],
+  "pypug": ["https://packaging.python.org/en/latest/", null],
+  "anndata": ["https://anndata.readthedocs.io/en/stable/", null],
+  "asdf-astropy": ["https://asdf-astropy.readthedocs.io/en/latest/", null],
+  "astropy-dev": ["https://docs.astropy.org/en/latest/", null],
+  "asv": ["https://asv.readthedocs.io/en/stable/", null],
+  "asyncssh": ["https://asyncssh.readthedocs.io/en/latest/", null],
+  "attrs": ["https://www.attrs.org/en/stable/", null],
+  "bhub": ["https://binderhub.readthedocs.io/en/latest/", null],
+  "bokeh": ["https://docs.bokeh.org/en/latest/", null],
+  "boltons": ["https://boltons.readthedocs.io/en/latest/", null],
+  "bottle": ["https://bottlepy.org/docs/dev/", null],
+  "build": ["https://build.pypa.io/en/latest/", null],
+  "cartopy": ["https://scitools.org.uk/cartopy/docs/latest/", null],
+  "cffi": ["https://cffi.readthedocs.io/en/latest/", null],
+  "click": ["https://click.palletsprojects.com/", null],
+  "conda": ["https://conda.io/en/latest/", null],
+  "cycler": ["https://matplotlib.org/cycler/", null],
+  "cython": ["https://docs.cython.org/en/latest/", null],
+  "dask": ["https://docs.dask.org/en/latest/", null],
+  "dateutil": ["https://dateutil.readthedocs.io/en/latest/", null],
+  "devguide": ["https://devguide.python.org/", null],
+  "devpi": ["https://devpi.net/docs/devpi/devpi/latest/+doc/", null],
+  "dh-virtualenv": ["https://dh-virtualenv.readthedocs.io/en/latest/", null],
+  "dipy": ["https://docs.dipy.org/stable/", null],
+  "distlib": ["https://distlib.readthedocs.io/en/latest/", null],
+  "distributed": ["https://distributed.dask.org/en/stable/", null],
+  "django": [
+    "https://docs.djangoproject.com/en/2.2/",
+    "https://docs.djangoproject.com/en/2.2/_objects/"
+  ],
+  "dlpack": ["https://dmlc.github.io/dlpack/latest/", null],
+  "flax": ["https://flax.readthedocs.io/en/latest/", null],
+  "flexx": ["https://flexx.readthedocs.io/en/latest/", null],
+  "fsspec": ["https://filesystem-spec.readthedocs.io/en/latest/", null],
+  "geopandas": ["https://geopandas.org/en/stable/", null],
+  "hub": ["https://jupyterhub.readthedocs.io/en/latest/", null],
+  "imageio": ["https://imageio.readthedocs.io/en/stable/", null],
+  "importlib-resources": [
+    "https://importlib-resources.readthedocs.io/en/latest/",
+    null
+  ],
+  "ipykernel": ["https://ipykernel.readthedocs.io/en/latest/", null],
+  "ipyleaflet": ["https://ipyleaflet.readthedocs.io/en/latest/", null],
+  "ipyparallel": ["https://ipyparallel.readthedocs.io/en/latest/", null],
+  "ipython": ["https://ipython.readthedocs.io/en/latest/", null],
+  "ipywidgets": ["https://ipywidgets.readthedocs.io/en/latest/", null],
+  "jax": ["https://jax.readthedocs.io/en/latest/", null],
+  "jedi": ["https://jedi.readthedocs.io/en/latest/", null],
+  "jinja": ["http://jinja.pocoo.org/docs/", null],
+  "joblib": ["https://joblib.readthedocs.io/en/latest/", null],
+  "jupyter": ["https://docs.jupyter.org/en/latest/", null],
+  "jupyter-server": ["https://jupyter-server.readthedocs.io/en/stable/", null],
+  "jupyter_core": ["https://jupyter-core.readthedocs.io/en/stable/", null],
+  "jupyterbook": ["https://jupyterbook.org/en/stable/", null],
+  "jupyterclient": ["https://jupyter-client.readthedocs.io/en/latest/", null],
+  "jupytercore": ["https://jupyter-core.readthedocs.io/en/latest/", null],
+  "jupytext": ["https://jupytext.readthedocs.io/en/stable/", null],
+  "kwarray": ["https://kwarray.readthedocs.io/en/latest/", null],
+  "kwimage": ["https://kwimage.readthedocs.io/en/latest/", null],
+  "lab": ["https://jupyterlab.readthedocs.io/en/latest/", null],
+  "llvmlite": ["https://llvmlite.readthedocs.io/en/latest/", null],
+  "lxml": ["https://lxml.de/apidoc/", null],
+  "magicgui": ["https://pyapp-kit.github.io/magicgui/", null],
+  "markdown_it": ["https://markdown-it-py.readthedocs.io/en/latest/", null],
+  "matplotlib": ["https://matplotlib.org/stable/", null],
+  "meson-python": ["https://meson-python.readthedocs.io/en/stable/", null],
+  "mne": ["https://mne.tools/stable/", null],
+  "monkeytype": ["https://monkeytype.readthedocs.io/en/latest/", null],
+  "mpmath": ["https://mpmath.org/doc/current/", null],
+  "myst-nb": ["https://myst-nb.readthedocs.io/en/v0.12.3/", null],
+  "myst-parser": ["https://myst-parser.readthedocs.io/en/v0.15.1/", null],
+  "napari_plugin_engine": [
+    "https://napari-plugin-engine.readthedocs.io/en/latest/",
+    null
+  ],
+  "nbconvert": ["https://nbconvert.readthedocs.io/en/latest/", null],
+  "nbformat": ["https://nbformat.readthedocs.io/en/latest/", null],
+  "nbgitpuller": ["https://nbgitpuller.readthedocs.io/en/latest/", null],
+  "nbsphinx": ["https://nbsphinx.readthedocs.io/", null],
+  "ndsampler": ["https://ndsampler.readthedocs.io/en/latest/", null],
+  "neps": ["https://numpy.org/neps/", null],
+  "networkx": ["https://networkx.org/documentation/stable/", null],
+  "nibabel": ["https://nipy.org/nibabel/", null],
+  "nilearn": ["https://nilearn.github.io/stable/", null],
+  "notebook": ["https://jupyter-notebook.readthedocs.io/en/stable/", null],
+  "nox": ["https://nox.thea.codes/en/latest/", null],
+  "numba": ["https://numba.readthedocs.io/en/latest/", null],
+  "numpy": ["https://numpy.org/doc/stable/", null],
+  "numpy-tutorials": ["https://numpy.org/numpy-tutorials/", null],
+  "numpydoc": ["https://numpydoc.readthedocs.io/en/latest/", null],
+  "nx-guides": ["https://networkx.org/nx-guides/", null],
+  "openstack": ["https://docs.openstack.org/glance/latest/", null],
+  "pandas": ["https://pandas.pydata.org/docs/", null],
+  "pandas-gbq": ["https://pandas-gbq.readthedocs.io/en/latest/", null],
+  "parso": ["https://parso.readthedocs.io/en/latest/", null],
+  "patsy": ["https://patsy.readthedocs.io/en/latest/", null],
+  "pip": ["https://pip.pypa.io/en/latest/", null],
+  "pipenv": ["https://pipenv.pypa.io/en/latest/", null],
+  "piwheels": ["https://piwheels.readthedocs.io/en/latest/", null],
+  "pluggy": ["https://pluggy.readthedocs.io/en/stable/", null],
+  "poliastro": ["https://docs.poliastro.space/en/stable/", null],
+  "prompt_toolkit": [
+    "https://python-prompt-toolkit.readthedocs.io/en/stable/",
+    null
+  ],
+  "py": ["https://pylib.readthedocs.io/en/latest/", null],
+  "pyarrow": ["https://arrow.apache.org/docs/", null],
+  "pybind11": ["https://pybind11.readthedocs.io/en/stable/", null],
+  "pyerfa": ["https://pyerfa.readthedocs.io/en/stable/", null],
+  "pygraphviz": ["https://pygraphviz.github.io/documentation/stable/", null],
+  "pymde": ["https://pymde.org/", null],
+  "pymongo": ["https://pymongo.readthedocs.io/en/stable/", null],
+  "pynsist": ["https://pynsist.readthedocs.io/en/latest/", null],
+  "pypa": ["https://www.pypa.io/en/latest/", null],
+  "pypug": ["https://packaging.python.org/en/latest/", null],
+  "pypy": ["https://doc.pypy.org/en/latest/", null],
+  "pyqtgraph": ["https://pyqtgraph.readthedocs.io/en/latest/", null],
+  "pyro": ["https://docs.pyro.ai/en/stable/", null],
+  "pytest": ["https://pytest.org/en/stable/", null],
+  "python": ["https://docs.python.org/3/", null],
+  "python-guide": ["https://docs.python-guide.org/", null],
+  "pytorch_lightning": ["https://lightning.ai/docs/pytorch/stable/", null],
+  "pyvista": ["https://docs.pyvista.org/version/stable/", null],
+  "qiskit": ["https://docs.quantum.ibm.com/api/qiskit/", null],
+  "qtconsole": ["https://jupyter.org/qtconsole/dev/", null],
+  "readthedocs": ["https://docs.readthedocs.io/en/stable/", null],
+  "requests": ["https://docs.python-requests.org/en/latest/", null],
+  "rpy2": ["https://rpy2.github.io/doc/latest/html/", null],
+  "rst-to-myst": ["https://rst-to-myst.readthedocs.io/en/stable/", null],
+  "rtd": ["https://docs.readthedocs.io/en/stable/", null],
+  "rtd-dev": ["https://dev.readthedocs.io/en/latest/", null],
+  "scanpy": ["https://scanpy.readthedocs.io/en/stable/", null],
+  "scipy": ["https://docs.scipy.org/doc/scipy/", null],
+  "scipy-lecture-notes": ["https://scipy-lectures.org/", null],
+  "scriptconfig": ["https://scriptconfig.readthedocs.io/en/latest/", null],
+  "seaborn": ["https://seaborn.pydata.org/", null],
+  "server": ["https://jupyter-server.readthedocs.io/en/stable/", null],
+  "setuptools": ["https://setuptools.pypa.io/en/stable/", null],
+  "six": ["https://six.readthedocs.io/", null],
+  "skimage": ["https://scikit-image.org/docs/stable/", null],
+  "sklearn": ["https://scikit-learn.org/stable/", null],
+  "spack": ["https://spack.readthedocs.io/en/latest/", null],
+  "sparse": ["https://sparse.pydata.org/en/latest/", null],
+  "sphinx": ["https://www.sphinx-doc.org/en/master/", null],
+  "sphinx-gallery": ["https://sphinx-gallery.github.io/stable/", null],
+  "sphinx_automodapi": ["https://sphinx-automodapi.readthedocs.io/en/stable/", null],
+  "sqlalchemy": ["https://docs.sqlalchemy.org/en/latest/", null],
+  "statsmodels": ["https://www.statsmodels.org/stable/", null],
+  "sympy": ["https://docs.sympy.org/latest/", null],
+  "tljh": ["https://tljh.jupyter.org/en/latest/", null],
+  "torch": ["https://pytorch.org/docs/master/", null],
+  "tornado": ["https://www.tornadoweb.org/en/stable/", null],
+  "tox": ["https://tox.wiki/en/stable/", null],
+  "traitlets": ["https://traitlets.readthedocs.io/en/latest/", null],
+  "twine": ["https://twine.readthedocs.io/en/stable/", null],
+  "typing": ["https://typing.readthedocs.io/en/latest/", null],
+  "ubelt": ["https://ubelt.readthedocs.io/en/latest/", null],
+  "urwid": ["https://urwid.org/", null],
+  "virtualenv": ["https://virtualenv.pypa.io/en/stable/", null],
+  "writethedocs": ["https://www.writethedocs.org/", null],
+  "xarray": ["https://docs.xarray.dev/en/stable/", null],
+  "xdoctest": ["https://xdoctest.readthedocs.io/en/latest/", null],
+  "z2jh": ["https://z2jh.jupyter.org/en/latest/", null],
+  "zarr": ["https://zarr.readthedocs.io/en/latest/", null]
+}

intersphinx_registry-0.2405.27.dist-info/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Matthias Bussonnier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

intersphinx_registry-0.2405.27.dist-info/METADATA

@@ -0,0 +1,52 @@
+Metadata-Version: 2.1
+Name: intersphinx_registry
+Version: 0.2405.27
+Summary: This package provides convenient utilities and data to write a sphinx config file.
+Author-email: Matthias Bussonnier <bussonniermatthias@gmail.com>
+Description-Content-Type: text/markdown
+Classifier: License :: OSI Approved :: MIT License
+Requires-Dist: pytest>=7.0 ; extra == "tests"
+Requires-Dist: pytest-xdist ; extra == "tests"
+Requires-Dist: requests ; extra == "tests"
+Project-URL: Home, https://github.com/Carreau/intersphinx_registry
+Provides-Extra: tests
+
+# Intersphinx Registry
+
+A simple utility package that provide default inter sphinx mapping for a large chunk of the python ecosystem.
+
+Usage in `conf.py`
+
+```python
+from intersphinx_registry import get_intersphinx_mapping
+
+# ...
+intersphinx_mapping = get_intersphinx_mapping(
+    only={"ipython", "matplotlib", "pandas", "python"}
+)
+intersphinx_mapping.update({
+    'overwrite': ('<url>', None),
+    'my-package' : ('<url>', None),
+})
+```
+
+
+## Why ?
+
+Sometime packages docs move and it's hard to keep track of. We _try_ to keep the
+registry up to date, so yo do not have to ask yourself questions and update your
+intersphinx-mapping.
+
+You also might not want to think about adding intersphinx mapping when you refer
+to dependencies.
+
+## A package url is wrong !
+
+Please send a PR updating only this package in the `registry.json`. We try to
+link only to _stable_ package, not dev versions.
+
+## A package is missing !
+
+We can't do all packages, but if you think a package is widely used and missing,
+please send a PR.
+

intersphinx_registry-0.2405.27.dist-info/RECORD

@@ -0,0 +1,7 @@
+intersphinx_registry/__init__.py,sha256=eAB_hqzhnyj06um4lBwGMDNsL-K935ehzwuz9j5qgeI,1705
+intersphinx_registry/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+intersphinx_registry/registry.json,sha256=4sBhqiMSWXN65Zta-CK1TqFsEOHG3ylxQpZIMstEZbk,9785
+intersphinx_registry-0.2405.27.dist-info/LICENSE,sha256=j98x_c52nvqkLlr-U8tUaubJG3IBCIFEInYE4L_Yqqo,1086
+intersphinx_registry-0.2405.27.dist-info/WHEEL,sha256=Sgu64hAMa6g5FdzHxXv9Xdse9yxpGGMeagVtPMWpJQY,99
+intersphinx_registry-0.2405.27.dist-info/METADATA,sha256=4iFBnKcB--j8tXF9h5sclfiH9DgemekI3i8yTKI9bpQ,1560
+intersphinx_registry-0.2405.27.dist-info/RECORD,,

intersphinx_registry-0.2405.27.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: flit 3.9.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any