intersphinx_registry

Name	intersphinx_registry JSON
Version	0.2408.13 JSON
	download
home_page	None
Summary	This package provides convenient utilities and data to write a sphinx config file.
upload_time	2024-08-13 10:24:26
maintainer	None
docs_url	None
author	None
requires_python	None
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # 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(
    packages={"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.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "intersphinx_registry",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Matthias Bussonnier <bussonniermatthias@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/22/93/94ebb542ad34a3e1573b0c7df8dfba22015ba76a00266bbbca5d14eea5b0/intersphinx_registry-0.2408.13.tar.gz",
    "platform": null,
    "description": "# Intersphinx Registry\n\nA simple utility package that provide default inter sphinx mapping for a large chunk of the python ecosystem.\n\nUsage in `conf.py`\n\n```python\nfrom intersphinx_registry import get_intersphinx_mapping\n\n# ...\nintersphinx_mapping = get_intersphinx_mapping(\n    packages={\"ipython\", \"matplotlib\", \"pandas\", \"python\"}\n)\nintersphinx_mapping.update({\n    'overwrite': ('<url>', None),\n    'my-package' : ('<url>', None),\n})\n```\n\n\n## Why ?\n\nSometime packages docs move and it's hard to keep track of. We _try_ to keep the\nregistry up to date, so yo do not have to ask yourself questions and update your\nintersphinx-mapping.\n\nYou also might not want to think about adding intersphinx mapping when you refer\nto dependencies.\n\n## A package url is wrong !\n\nPlease send a PR updating only this package in the `registry.json`. We try to\nlink only to _stable_ package, not dev versions.\n\n## A package is missing !\n\nWe can't do all packages, but if you think a package is widely used and missing,\nplease send a PR.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "This package provides convenient utilities and data to write a sphinx config file.",
    "version": "0.2408.13",
    "project_urls": {
        "Home": "https://github.com/Quansight-labs/intersphinx_registry"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7d7669e705de54f6019730073c41da5c49e0e13fb4f43533fb5d45ccf1835d9a",
                "md5": "b66d9b791bdb0635965f6f3b4418b9bc",
                "sha256": "144b64633116905e35c1a2ad66244f41378762bf784074cfe5eee1845f4316d8"
            },
            "downloads": -1,
            "filename": "intersphinx_registry-0.2408.13-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b66d9b791bdb0635965f6f3b4418b9bc",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 6243,
            "upload_time": "2024-08-13T10:24:24",
            "upload_time_iso_8601": "2024-08-13T10:24:24.466093Z",
            "url": "https://files.pythonhosted.org/packages/7d/76/69e705de54f6019730073c41da5c49e0e13fb4f43533fb5d45ccf1835d9a/intersphinx_registry-0.2408.13-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "229394ebb542ad34a3e1573b0c7df8dfba22015ba76a00266bbbca5d14eea5b0",
                "md5": "e9c414d2586e76f72cd2d3c0d459349e",
                "sha256": "38a23a46e8a8c10583a730a6c54c35a244de2c24cc2d3ef320ead2b87be117cb"
            },
            "downloads": -1,
            "filename": "intersphinx_registry-0.2408.13.tar.gz",
            "has_sig": false,
            "md5_digest": "e9c414d2586e76f72cd2d3c0d459349e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6855,
            "upload_time": "2024-08-13T10:24:26",
            "upload_time_iso_8601": "2024-08-13T10:24:26.179253Z",
            "url": "https://files.pythonhosted.org/packages/22/93/94ebb542ad34a3e1573b0c7df8dfba22015ba76a00266bbbca5d14eea5b0/intersphinx_registry-0.2408.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-13 10:24:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Quansight-labs",
    "github_project": "intersphinx_registry",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "intersphinx_registry"
}