#########################
seed_intersphinx_mapping
#########################
.. start short_desc
**Populate the Sphinx 'intersphinx_mapping' dictionary from the project's requirements.**
.. end short_desc
.. start shields
.. list-table::
:stub-columns: 1
:widths: 10 90
* - Docs
- |docs| |docs_check|
* - Tests
- |actions_linux| |actions_windows| |actions_macos| |coveralls|
* - PyPI
- |pypi-version| |supported-versions| |supported-implementations| |wheel|
* - Anaconda
- |conda-version| |conda-platform|
* - Activity
- |commits-latest| |commits-since| |maintained| |pypi-downloads|
* - QA
- |codefactor| |actions_flake8| |actions_mypy|
* - Other
- |license| |language| |requires|
.. |docs| image:: https://img.shields.io/readthedocs/seed-intersphinx-mapping/latest?logo=read-the-docs
:target: https://seed-intersphinx-mapping.readthedocs.io/en/latest
:alt: Documentation Build Status
.. |docs_check| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/Docs%20Check/badge.svg
:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22Docs+Check%22
:alt: Docs Check Status
.. |actions_linux| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/Linux/badge.svg
:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22Linux%22
:alt: Linux Test Status
.. |actions_windows| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/Windows/badge.svg
:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22Windows%22
:alt: Windows Test Status
.. |actions_macos| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/macOS/badge.svg
:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22macOS%22
:alt: macOS Test Status
.. |actions_flake8| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/Flake8/badge.svg
:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22Flake8%22
:alt: Flake8 Status
.. |actions_mypy| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/mypy/badge.svg
:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22mypy%22
:alt: mypy status
.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/seed_intersphinx_mapping/badge.svg
:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/seed_intersphinx_mapping/
:alt: Requirements Status
.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/seed_intersphinx_mapping/master?logo=coveralls
:target: https://coveralls.io/github/sphinx-toolbox/seed_intersphinx_mapping?branch=master
:alt: Coverage
.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/seed_intersphinx_mapping?logo=codefactor
:target: https://www.codefactor.io/repository/github/sphinx-toolbox/seed_intersphinx_mapping
:alt: CodeFactor Grade
.. |pypi-version| image:: https://img.shields.io/pypi/v/seed_intersphinx_mapping
:target: https://pypi.org/project/seed_intersphinx_mapping/
:alt: PyPI - Package Version
.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/seed_intersphinx_mapping?logo=python&logoColor=white
:target: https://pypi.org/project/seed_intersphinx_mapping/
:alt: PyPI - Supported Python Versions
.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/seed_intersphinx_mapping
:target: https://pypi.org/project/seed_intersphinx_mapping/
:alt: PyPI - Supported Implementations
.. |wheel| image:: https://img.shields.io/pypi/wheel/seed_intersphinx_mapping
:target: https://pypi.org/project/seed_intersphinx_mapping/
:alt: PyPI - Wheel
.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/seed_intersphinx_mapping?logo=anaconda
:target: https://anaconda.org/domdfcoding/seed_intersphinx_mapping
:alt: Conda - Package Version
.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/seed_intersphinx_mapping?label=conda%7Cplatform
:target: https://anaconda.org/domdfcoding/seed_intersphinx_mapping
:alt: Conda - Platform
.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/seed_intersphinx_mapping
:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/blob/master/LICENSE
:alt: License
.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/seed_intersphinx_mapping
:alt: GitHub top language
.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/seed_intersphinx_mapping/v1.2.1
:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/pulse
:alt: GitHub commits since tagged version
.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/seed_intersphinx_mapping
:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/commit/master
:alt: GitHub last commit
.. |maintained| image:: https://img.shields.io/maintenance/yes/2023
:alt: Maintenance
.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/seed_intersphinx_mapping
:target: https://pypi.org/project/seed_intersphinx_mapping/
:alt: PyPI - Downloads
.. end shields
This avoids having to manually compile (and keep updated) a mapping like:
.. code-block:: python
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?
.. _Project-URL: https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
.. _core metadata: https://packaging.python.org/specifications/core-metadata
.. _pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests
.. _the documentation: https://seed-intersphinx-mapping.readthedocs.io/en/latest/
Installation
--------------
.. start installation
``seed_intersphinx_mapping`` can be installed from PyPI or Anaconda.
To install with ``pip``:
.. code-block:: bash
$ python -m pip install seed_intersphinx_mapping
To install with ``conda``:
* First add the required channels
.. code-block:: bash
$ conda config --add channels https://conda.anaconda.org/conda-forge
$ conda config --add channels https://conda.anaconda.org/domdfcoding
* Then install
.. code-block:: bash
$ conda install seed_intersphinx_mapping
.. end installation
Enable ``seed_intersphinx_mapping`` by adding "seed_intersphinx_mapping" to the ``extensions`` variable in ``conf.py``:
.. code-block:: python
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``.
.. _the documentation: https://seed-intersphinx-mapping.readthedocs.io/en/latest/
Raw data
{
"_id": null,
"home_page": "https://github.com/sphinx-toolbox/seed_intersphinx_mapping",
"name": "seed-intersphinx-mapping",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "documentation,intersphinx,sphinx",
"author": "",
"author_email": "Dominic Davis-Foster <dominic@davis-foster.co.uk>",
"download_url": "https://files.pythonhosted.org/packages/78/71/020eda2813762819060181a357d8564f227289283a337f828bdc76287b55/seed_intersphinx_mapping-1.2.1.tar.gz",
"platform": "Windows",
"description": "\n#########################\nseed_intersphinx_mapping\n#########################\n\n.. start short_desc\n\n**Populate the Sphinx 'intersphinx_mapping' dictionary from the project's requirements.**\n\n.. end short_desc\n\n\n.. start shields\n\n.. list-table::\n\t:stub-columns: 1\n\t:widths: 10 90\n\n\t* - Docs\n\t - |docs| |docs_check|\n\t* - Tests\n\t - |actions_linux| |actions_windows| |actions_macos| |coveralls|\n\t* - PyPI\n\t - |pypi-version| |supported-versions| |supported-implementations| |wheel|\n\t* - Anaconda\n\t - |conda-version| |conda-platform|\n\t* - Activity\n\t - |commits-latest| |commits-since| |maintained| |pypi-downloads|\n\t* - QA\n\t - |codefactor| |actions_flake8| |actions_mypy|\n\t* - Other\n\t - |license| |language| |requires|\n\n.. |docs| image:: https://img.shields.io/readthedocs/seed-intersphinx-mapping/latest?logo=read-the-docs\n\t:target: https://seed-intersphinx-mapping.readthedocs.io/en/latest\n\t:alt: Documentation Build Status\n\n.. |docs_check| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/Docs%20Check/badge.svg\n\t:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22Docs+Check%22\n\t:alt: Docs Check Status\n\n.. |actions_linux| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/Linux/badge.svg\n\t:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22Linux%22\n\t:alt: Linux Test Status\n\n.. |actions_windows| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/Windows/badge.svg\n\t:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22Windows%22\n\t:alt: Windows Test Status\n\n.. |actions_macos| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/macOS/badge.svg\n\t:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22macOS%22\n\t:alt: macOS Test Status\n\n.. |actions_flake8| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/Flake8/badge.svg\n\t:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22Flake8%22\n\t:alt: Flake8 Status\n\n.. |actions_mypy| image:: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/workflows/mypy/badge.svg\n\t:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/actions?query=workflow%3A%22mypy%22\n\t:alt: mypy status\n\n.. |requires| image:: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/seed_intersphinx_mapping/badge.svg\n\t:target: https://dependency-dash.repo-helper.uk/github/sphinx-toolbox/seed_intersphinx_mapping/\n\t:alt: Requirements Status\n\n.. |coveralls| image:: https://img.shields.io/coveralls/github/sphinx-toolbox/seed_intersphinx_mapping/master?logo=coveralls\n\t:target: https://coveralls.io/github/sphinx-toolbox/seed_intersphinx_mapping?branch=master\n\t:alt: Coverage\n\n.. |codefactor| image:: https://img.shields.io/codefactor/grade/github/sphinx-toolbox/seed_intersphinx_mapping?logo=codefactor\n\t:target: https://www.codefactor.io/repository/github/sphinx-toolbox/seed_intersphinx_mapping\n\t:alt: CodeFactor Grade\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/seed_intersphinx_mapping\n\t:target: https://pypi.org/project/seed_intersphinx_mapping/\n\t:alt: PyPI - Package Version\n\n.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/seed_intersphinx_mapping?logo=python&logoColor=white\n\t:target: https://pypi.org/project/seed_intersphinx_mapping/\n\t:alt: PyPI - Supported Python Versions\n\n.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/seed_intersphinx_mapping\n\t:target: https://pypi.org/project/seed_intersphinx_mapping/\n\t:alt: PyPI - Supported Implementations\n\n.. |wheel| image:: https://img.shields.io/pypi/wheel/seed_intersphinx_mapping\n\t:target: https://pypi.org/project/seed_intersphinx_mapping/\n\t:alt: PyPI - Wheel\n\n.. |conda-version| image:: https://img.shields.io/conda/v/domdfcoding/seed_intersphinx_mapping?logo=anaconda\n\t:target: https://anaconda.org/domdfcoding/seed_intersphinx_mapping\n\t:alt: Conda - Package Version\n\n.. |conda-platform| image:: https://img.shields.io/conda/pn/domdfcoding/seed_intersphinx_mapping?label=conda%7Cplatform\n\t:target: https://anaconda.org/domdfcoding/seed_intersphinx_mapping\n\t:alt: Conda - Platform\n\n.. |license| image:: https://img.shields.io/github/license/sphinx-toolbox/seed_intersphinx_mapping\n\t:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/blob/master/LICENSE\n\t:alt: License\n\n.. |language| image:: https://img.shields.io/github/languages/top/sphinx-toolbox/seed_intersphinx_mapping\n\t:alt: GitHub top language\n\n.. |commits-since| image:: https://img.shields.io/github/commits-since/sphinx-toolbox/seed_intersphinx_mapping/v1.2.1\n\t:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/pulse\n\t:alt: GitHub commits since tagged version\n\n.. |commits-latest| image:: https://img.shields.io/github/last-commit/sphinx-toolbox/seed_intersphinx_mapping\n\t:target: https://github.com/sphinx-toolbox/seed_intersphinx_mapping/commit/master\n\t:alt: GitHub last commit\n\n.. |maintained| image:: https://img.shields.io/maintenance/yes/2023\n\t:alt: Maintenance\n\n.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/seed_intersphinx_mapping\n\t:target: https://pypi.org/project/seed_intersphinx_mapping/\n\t:alt: PyPI - Downloads\n\n.. end shields\n\n\nThis avoids having to manually compile (and keep updated) a mapping like:\n\n.. code-block:: python\n\n\tintersphinx_mapping = {\n\t\t\t\"attrs\": (\"https://www.attrs.org/en/stable/\", None),\n\t\t\t\"Flask\": (\"https://flask.palletsprojects.com/en/1.1.x/\", None),\n\t\t\t\"matplotlib\": (\"https://matplotlib.org/stable/\", None),\n\t\t\t\"numpy\": (\"https://numpy.org/doc/stable/\", None),\n\t\t\t\"pandas\": (\"https://pandas.pydata.org/docs/\", None),\n\t\t\t\"Pyramid\": (\"https://docs.pylonsproject.org/projects/pyramid/en/latest/\", None),\n\t\t\t\"scikit-learn\": (\"https://scikit-learn.org/stable/\", None),\n\t\t\t\"scipy\": (\"https://docs.scipy.org/doc/scipy/reference/\", None),\n\t\t\t\"Sphinx\": (\"https://www.sphinx-doc.org/en/stable/\", None),\n\t\t\t}\n\t# Source: https://gist.github.com/bskinn/0e164963428d4b51017cebdb6cda5209\n\n\nSee `the documentation`_ for more information.\n\n**Note:** Not all projects include a link to their documentation in the Project-URL_ field of Python's `core metadata`_.\nWhy not submit a `pull request`_ to them to include it?\n\n.. _Project-URL: https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use\n.. _core metadata: https://packaging.python.org/specifications/core-metadata\n.. _pull request: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests\n.. _the documentation: https://seed-intersphinx-mapping.readthedocs.io/en/latest/\n\nInstallation\n--------------\n\n.. start installation\n\n``seed_intersphinx_mapping`` can be installed from PyPI or Anaconda.\n\nTo install with ``pip``:\n\n.. code-block:: bash\n\n\t$ python -m pip install seed_intersphinx_mapping\n\nTo install with ``conda``:\n\n\t* First add the required channels\n\n\t.. code-block:: bash\n\n\t\t$ conda config --add channels https://conda.anaconda.org/conda-forge\n\t\t$ conda config --add channels https://conda.anaconda.org/domdfcoding\n\n\t* Then install\n\n\t.. code-block:: bash\n\n\t\t$ conda install seed_intersphinx_mapping\n\n.. end installation\n\n\nEnable ``seed_intersphinx_mapping`` by adding \"seed_intersphinx_mapping\" to the ``extensions`` variable in ``conf.py``:\n\n.. code-block:: python\n\n extensions = [\n\t\t...\n\t\t\"seed_intersphinx_mapping\",\n\t\t]\n\nFor more information see https://www.sphinx-doc.org/en/master/usage/extensions/index.html#third-party-extensions .\n\nSee `the documentation`_ for more information on configuring ``seed_intersphinx_mapping``.\n\n.. _the documentation: https://seed-intersphinx-mapping.readthedocs.io/en/latest/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Populate the Sphinx 'intersphinx_mapping' dictionary from the project's requirements.",
"version": "1.2.1",
"split_keywords": [
"documentation",
"intersphinx",
"sphinx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7cd6993758ca0eefced654efffa0127cfe59b9b07580f91e48822f414ae608c1",
"md5": "8e1b7a312c2edadc18a7b6f2d2c3cdba",
"sha256": "eddf029fe57f16de059365f9e1502b517246226f63a6d98eee8d9d43fc0ef4cc"
},
"downloads": -1,
"filename": "seed_intersphinx_mapping-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8e1b7a312c2edadc18a7b6f2d2c3cdba",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 33223,
"upload_time": "2023-04-14T18:11:37",
"upload_time_iso_8601": "2023-04-14T18:11:37.068718Z",
"url": "https://files.pythonhosted.org/packages/7c/d6/993758ca0eefced654efffa0127cfe59b9b07580f91e48822f414ae608c1/seed_intersphinx_mapping-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7871020eda2813762819060181a357d8564f227289283a337f828bdc76287b55",
"md5": "74a4d9b2ec39f48508000fe0f10595e8",
"sha256": "c20b4ec423e2550f1027031a15489a2f47de748bbbe0405bcbdac41d2469d1bf"
},
"downloads": -1,
"filename": "seed_intersphinx_mapping-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "74a4d9b2ec39f48508000fe0f10595e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9213,
"upload_time": "2023-04-14T18:11:38",
"upload_time_iso_8601": "2023-04-14T18:11:38.868264Z",
"url": "https://files.pythonhosted.org/packages/78/71/020eda2813762819060181a357d8564f227289283a337f828bdc76287b55/seed_intersphinx_mapping-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-14 18:11:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "sphinx-toolbox",
"github_project": "seed_intersphinx_mapping",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "seed-intersphinx-mapping"
}
JSON
