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 |
|
---|---|
Tests |
|
PyPI |
|
Anaconda |
|
Activity |
|
QA |
|
Other |
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file seed_intersphinx_mapping-1.2.2.tar.gz
.
File metadata
- Download URL: seed_intersphinx_mapping-1.2.2.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | baacbebf001c3123c006d2b498aa21c036db6ff8cc4032c2b958e464c6700bfd |
|
MD5 | 4c6f9531a16514d1762f44c9d8393d37 |
|
BLAKE2b-256 | 79585be24d0f4df6f517953d56b70f5e8da5db44875c2c548a37e121308ab9c8 |
File details
Details for the file seed_intersphinx_mapping-1.2.2-py3-none-any.whl
.
File metadata
- Download URL: seed_intersphinx_mapping-1.2.2-py3-none-any.whl
- Upload date:
- Size: 33.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.17
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c16ee5456681c2b5d8897a9828ddf700f0fa3b17d8520d6c56ded7a7c8e92808 |
|
MD5 | 589e373cdd1de77ad9b1e0170f289adf |
|
BLAKE2b-256 | da807c536165ebb0dfdc735a82378b368bb5237a2d44899af79d2f7598e5394b |