Skip to main content

seed_intersphinx_mapping

Populate the Sphinx ‘intersphinx_mapping’ dictionary from the project’s requirements.

Docs

Documentation Build Status Docs Check Status

Tests

Linux Test Status Windows Test Status macOS Test Status Coverage

PyPI

PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel

Anaconda

Conda - Package Version Conda - Platform

Activity

GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads

QA

CodeFactor Grade Flake8 Status mypy status

Other

License GitHub top language Requirements Status

This avoids having to manually compile (and keep updated) a mapping like:

intersphinx_mapping = {
                "attrs": ("https://www.attrs.org/en/stable/", None),
                "Flask": ("https://flask.palletsprojects.com/en/1.1.x/", None),
                "matplotlib": ("https://matplotlib.org/stable/", None),
                "numpy": ("https://numpy.org/doc/stable/", None),
                "pandas": ("https://pandas.pydata.org/docs/", None),
                "Pyramid": ("https://docs.pylonsproject.org/projects/pyramid/en/latest/", None),
                "scikit-learn": ("https://scikit-learn.org/stable/", None),
                "scipy": ("https://docs.scipy.org/doc/scipy/reference/", None),
                "Sphinx": ("https://www.sphinx-doc.org/en/stable/", None),
                }
# Source: https://gist.github.com/bskinn/0e164963428d4b51017cebdb6cda5209

See the documentation for more information.

Note: Not all projects include a link to their documentation in the Project-URL field of Python’s core metadata. Why not submit a pull request to them to include it?

Installation

seed_intersphinx_mapping can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install seed_intersphinx_mapping

To install with conda:

  • First add the required channels

$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
  • Then install

$ conda install seed_intersphinx_mapping

Enable seed_intersphinx_mapping by adding “seed_intersphinx_mapping” to the extensions variable in conf.py:

extensions = [
            ...
            "seed_intersphinx_mapping",
            ]

For more information see https://www.sphinx-doc.org/en/master/usage/extensions/index.html#third-party-extensions .

See the documentation for more information on configuring seed_intersphinx_mapping.

Release files for seed-intersphinx-mapping 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for seed-intersphinx-mapping 1.3.0
File Size Uploaded
seed_intersphinx_mapping-1.3.0.tar.gz 9.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for seed-intersphinx-mapping 1.3.0
File Interpreter ABI Platform
seed_intersphinx_mapping-1.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 23.2 kB

Release files / seed_intersphinx_mapping-1.3.0.tar.gz

Download URL seed_intersphinx_mapping-1.3.0.tar.gz
Size 9.4 kB
Tags Source
SHA-256 checksum
How to use checksums
e3b35fb6cfc4f83ca61ab457fe3cc81a90970716a4ae7eb59058b46779c58fa0
BLAKE2b-256 checksum
How to use checksums
5e63789eff6566d13974c5fb3a46e4c6e48dd528c10fbff54485d824cfd8e2fe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / seed_intersphinx_mapping-1.3.0-py3-none-any.whl

Download URL seed_intersphinx_mapping-1.3.0-py3-none-any.whl
Size 13.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
43ce60205e11a7d79233205f9e2c6d4fc2b58a2923be3e0b3663138d00f0228c
BLAKE2b-256 checksum
How to use checksums
cc33e939661c70d7902c22ebff32eb9ff58a8e6476634a1af0742f7025b43ea2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release history Release notifications | RSS feed

This release

1.3.0 This release

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page