Skip to main content

Populate the Sphinx 'intersphinx_mapping' dictionary from the project's requirements.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

seed_intersphinx_mapping-1.2.2.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

seed_intersphinx_mapping-1.2.2-py3-none-any.whl (33.3 kB view details)

Uploaded Python 3

File details

Details for the file seed_intersphinx_mapping-1.2.2.tar.gz.

File metadata

File hashes

Hashes for seed_intersphinx_mapping-1.2.2.tar.gz
Algorithm Hash digest
SHA256 baacbebf001c3123c006d2b498aa21c036db6ff8cc4032c2b958e464c6700bfd
MD5 4c6f9531a16514d1762f44c9d8393d37
BLAKE2b-256 79585be24d0f4df6f517953d56b70f5e8da5db44875c2c548a37e121308ab9c8

See more details on using hashes here.

File details

Details for the file seed_intersphinx_mapping-1.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for seed_intersphinx_mapping-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c16ee5456681c2b5d8897a9828ddf700f0fa3b17d8520d6c56ded7a7c8e92808
MD5 589e373cdd1de77ad9b1e0170f289adf
BLAKE2b-256 da807c536165ebb0dfdc735a82378b368bb5237a2d44899af79d2f7598e5394b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page