| Name | sphinx-codeautolink JSON |
| Version |
0.15.1
JSON |
| download |
| home_page | None |
| Summary | Automatic links from code examples to reference documentation. |
| upload_time | 2024-04-17 16:31:02 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2021-2023 Felix Hildén Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| 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
# or, alternatively:
$ 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 multiple examples
and setting default import statements among other things,
have a look at the online documentation.
.. |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.7",
"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/98/d1/eb1f07c175a4498105ea06bcd36cdb727846f0da1089b2e3a4f0060097b8/sphinx_codeautolink-0.15.1.tar.gz",
"platform": null,
"description": "sphinx-codeautolink\r\n===================\r\n|pyversions| |downloads| |license| |readthedocs|\r\n\r\nsphinx-codeautolink makes code examples clickable by inserting links\r\nfrom individual code elements to the corresponding reference documentation.\r\nWe aim for a minimal setup assuming your examples are already valid Python.\r\n\r\nFor a live demo, see our online documentation on\r\n`Read The Docs <https://sphinx-codeautolink.rtfd.org>`_.\r\n\r\nInstallation\r\n------------\r\nsphinx-codeautolink can be installed from the following sources:\r\n\r\n.. code:: sh\r\n\r\n $ pip install sphinx-codeautolink\r\n # or, alternatively:\r\n $ conda install -c conda-forge sphinx-codeautolink\r\n\r\nNote that the library is in early development, so version pinning is advised.\r\nTo enable sphinx-codeautolink, modify the extension list in ``conf.py``.\r\nNote that the extension name uses an underscore rather than a hyphen.\r\n\r\n.. code:: python\r\n\r\n extensions = [\r\n ...,\r\n \"sphinx_codeautolink\",\r\n ]\r\n\r\nThat's it! Now your code examples are linked.\r\nFor ways of concatenating multiple examples\r\nand setting default import statements among other things,\r\nhave a look at the online documentation.\r\n\r\n.. |pyversions| image:: https://img.shields.io/pypi/pyversions/sphinx-codeautolink\r\n :alt: Python versions\r\n\r\n.. |downloads| image:: https://img.shields.io/pypi/dm/sphinx-codeautolink\r\n :alt: Monthly downloads\r\n\r\n.. |license| image:: https://img.shields.io/badge/License-MIT-blue.svg\r\n :target: https://choosealicense.com/licenses/mit\r\n :alt: License: MIT\r\n\r\n.. |readthedocs| image:: https://rtfd.org/projects/sphinx-codeautolink/badge/?version=stable\r\n :target: https://sphinx-codeautolink.rtfd.org/en/stable/\r\n :alt: Documentation\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021-2023 Felix Hild\u00e9n Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Automatic links from code examples to reference documentation.",
"version": "0.15.1",
"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": "",
"digests": {
"blake2b_256": "8fbbc36ed9dbe5776d22f76589705e4513b91649bfa725c571ecb10f0e43bdde",
"md5": "22329a1481df102d4902319a528c1279",
"sha256": "c5e9d1c41463af31216aaaed3be149c2122b338bd0cfe87292ac47c970189986"
},
"downloads": -1,
"filename": "sphinx_codeautolink-0.15.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "22329a1481df102d4902319a528c1279",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 24868,
"upload_time": "2024-04-17T16:30:59",
"upload_time_iso_8601": "2024-04-17T16:30:59.533828Z",
"url": "https://files.pythonhosted.org/packages/8f/bb/c36ed9dbe5776d22f76589705e4513b91649bfa725c571ecb10f0e43bdde/sphinx_codeautolink-0.15.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "98d1eb1f07c175a4498105ea06bcd36cdb727846f0da1089b2e3a4f0060097b8",
"md5": "619afb4a57da0becf56c7f982ffe8091",
"sha256": "c4f88aa4a315ee26c8c1d7ffc11b3759764fadf7d8f0a861d780d4423eff93e6"
},
"downloads": -1,
"filename": "sphinx_codeautolink-0.15.1.tar.gz",
"has_sig": false,
"md5_digest": "619afb4a57da0becf56c7f982ffe8091",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 52800,
"upload_time": "2024-04-17T16:31:02",
"upload_time_iso_8601": "2024-04-17T16:31:02.181102Z",
"url": "https://files.pythonhosted.org/packages/98/d1/eb1f07c175a4498105ea06bcd36cdb727846f0da1089b2e3a4f0060097b8/sphinx_codeautolink-0.15.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 16:31:02",
"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"
}
