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
Hashes for seed_intersphinx_mapping-1.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c20b4ec423e2550f1027031a15489a2f47de748bbbe0405bcbdac41d2469d1bf |
|
MD5 | 74a4d9b2ec39f48508000fe0f10595e8 |
|
BLAKE2b-256 | 7871020eda2813762819060181a357d8564f227289283a337f828bdc76287b55 |
Hashes for seed_intersphinx_mapping-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eddf029fe57f16de059365f9e1502b517246226f63a6d98eee8d9d43fc0ef4cc |
|
MD5 | 8e1b7a312c2edadc18a7b6f2d2c3cdba |
|
BLAKE2b-256 | 7cd6993758ca0eefced654efffa0127cfe59b9b07580f91e48822f414ae608c1 |