| Name | sphinx-codeautolink JSON |
| Version |
0.17.5
JSON |
| download |
| home_page | None |
| Summary | Automatic links from code examples to reference documentation. |
| upload_time | 2025-07-09 15:22:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
sphinx
extension
code
link
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
sphinx-codeautolink
===================
|pyversions| |downloads| |license| |readthedocs|
sphinx-codeautolink makes code examples clickable by inserting links
from individual code elements to the corresponding reference documentation.
We aim for a minimal setup assuming your examples are already valid Python.
For a live demo, see our online documentation on
`Read The Docs <https://sphinx-codeautolink.rtfd.org>`_.
Installation
------------
sphinx-codeautolink can be installed from the following sources:
.. code:: sh
$ pip install sphinx-codeautolink
$ conda install -c conda-forge sphinx-codeautolink
Note that the library is in early development, so version pinning is advised.
To enable sphinx-codeautolink, modify the extension list in ``conf.py``.
Note that the extension name uses an underscore rather than a hyphen.
.. code:: python
extensions = [
...,
"sphinx_codeautolink",
]
That's it! Now your code examples are linked.
For ways of concatenating examples, setting default import statements,
or customising link style among other things,
see the `online documentation <https://sphinx-codeautolink.rtfd.org>`_.
.. |pyversions| image:: https://img.shields.io/pypi/pyversions/sphinx-codeautolink
:alt: Python versions
.. |downloads| image:: https://img.shields.io/pypi/dm/sphinx-codeautolink
:alt: Monthly downloads
.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg
:target: https://choosealicense.com/licenses/mit
:alt: License: MIT
.. |readthedocs| image:: https://rtfd.org/projects/sphinx-codeautolink/badge/?version=stable
:target: https://sphinx-codeautolink.rtfd.org/en/stable/
:alt: Documentation
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-codeautolink",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "Felix Hild\u00e9n <felix.hilden@gmail.com>",
"keywords": "sphinx, extension, code, link",
"author": null,
"author_email": "Felix Hild\u00e9n <felix.hilden@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/47/cf/96065111f706555ca3e0b5a7f57f47bae48983d48223d09f8800ba4b9b00/sphinx_codeautolink-0.17.5.tar.gz",
"platform": null,
"description": "sphinx-codeautolink\n===================\n|pyversions| |downloads| |license| |readthedocs|\n\nsphinx-codeautolink makes code examples clickable by inserting links\nfrom individual code elements to the corresponding reference documentation.\nWe aim for a minimal setup assuming your examples are already valid Python.\n\nFor a live demo, see our online documentation on\n`Read The Docs <https://sphinx-codeautolink.rtfd.org>`_.\n\nInstallation\n------------\nsphinx-codeautolink can be installed from the following sources:\n\n.. code:: sh\n\n $ pip install sphinx-codeautolink\n $ conda install -c conda-forge sphinx-codeautolink\n\nNote that the library is in early development, so version pinning is advised.\nTo enable sphinx-codeautolink, modify the extension list in ``conf.py``.\nNote that the extension name uses an underscore rather than a hyphen.\n\n.. code:: python\n\n extensions = [\n ...,\n \"sphinx_codeautolink\",\n ]\n\nThat's it! Now your code examples are linked.\nFor ways of concatenating examples, setting default import statements,\nor customising link style among other things,\nsee the `online documentation <https://sphinx-codeautolink.rtfd.org>`_.\n\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/sphinx-codeautolink\n :alt: Python versions\n\n.. |downloads| image:: https://img.shields.io/pypi/dm/sphinx-codeautolink\n :alt: Monthly downloads\n\n.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg\n :target: https://choosealicense.com/licenses/mit\n :alt: License: MIT\n\n.. |readthedocs| image:: https://rtfd.org/projects/sphinx-codeautolink/badge/?version=stable\n :target: https://sphinx-codeautolink.rtfd.org/en/stable/\n :alt: Documentation\n",
"bugtrack_url": null,
"license": null,
"summary": "Automatic links from code examples to reference documentation.",
"version": "0.17.5",
"project_urls": {
"documentation": "https://sphinx-codeautolink.rtfd.org",
"download": "https://pypi.org/project/sphinx-codeautolink",
"homepage": "https://pypi.org/project/sphinx-codeautolink",
"issues": "https://github.com/felix-hilden/sphinx-codeautolink/issues",
"source": "https://github.com/felix-hilden/sphinx-codeautolink"
},
"split_keywords": [
"sphinx",
" extension",
" code",
" link"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7be2a7232766639b8a447e5e1884f6f33bd704d213bc5d4eb376f81cd5a0cb1d",
"md5": "15260eb15931b03ebb0684c8ccf43016",
"sha256": "a84595ad3a12da93f82796e638f27e239d07b388037f3d3f69d65fc7ea6e05bf"
},
"downloads": -1,
"filename": "sphinx_codeautolink-0.17.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15260eb15931b03ebb0684c8ccf43016",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 35399,
"upload_time": "2025-07-09T15:22:33",
"upload_time_iso_8601": "2025-07-09T15:22:33.850771Z",
"url": "https://files.pythonhosted.org/packages/7b/e2/a7232766639b8a447e5e1884f6f33bd704d213bc5d4eb376f81cd5a0cb1d/sphinx_codeautolink-0.17.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "47cf96065111f706555ca3e0b5a7f57f47bae48983d48223d09f8800ba4b9b00",
"md5": "ad09c4c5e4b26de7dd6652d202b19696",
"sha256": "75098c20aa32de01481fa62409e6d2fbfdde760e6696ae9beb233a77bcb49283"
},
"downloads": -1,
"filename": "sphinx_codeautolink-0.17.5.tar.gz",
"has_sig": false,
"md5_digest": "ad09c4c5e4b26de7dd6652d202b19696",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 59686,
"upload_time": "2025-07-09T15:22:35",
"upload_time_iso_8601": "2025-07-09T15:22:35.452719Z",
"url": "https://files.pythonhosted.org/packages/47/cf/96065111f706555ca3e0b5a7f57f47bae48983d48223d09f8800ba4b9b00/sphinx_codeautolink-0.17.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 15:22:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "felix-hilden",
"github_project": "sphinx-codeautolink",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinx-codeautolink"
}
