.. |.functools.cached_property+cached_property| replace:: ``cached_property``
.. _.functools.cached_property+cached_property: https://docs.python.org/3/library/functools.html#functools.cached_property
.. |.property| replace:: ``property``
.. _.property: https://docs.python.org/3/library/functions.html#property
.. |.sphinx.ext.viewcode| replace:: ``sphinx.ext.viewcode``
.. _.sphinx.ext.viewcode: https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html#module-sphinx.ext.viewcode
.. meta::
:author: Adam Korn
:title: sphinx-inlinecode - embed source code blocks directly into Sphinx documentation
:description: A Sphinx extension to embed source code blocks directly into Sphinx documentation
sphinx-inlinecode
--------------------
.. image:: https://img.shields.io/pypi/v/sphinx-inlinecode?color=eb5202
:target: https://pypi.org/project/sphinx-inlinecode/
:alt: sphinx-inlinecode PyPI Version
.. image:: https://img.shields.io/badge/GitHub-sphinx--inlinecode-4f1abc
:target: https://github.com/tdkorn/sphinx-inlinecode/
:alt: sphinx-inlinecode GitHub Repository
.. image:: https://static.pepy.tech/personalized-badge/sphinx-inlinecode?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads
:target: https://pepy.tech/project/sphinx-inlinecode/
.. image:: https://readthedocs.org/projects/sphinx-inlinecode/badge/?version=latest
:target: https://sphinx-inlinecode.readthedocs.io/en/latest/?badge=latest
:alt: sphinx-inlinecode Documentation Status
|
``sphinx-inlinecode`` is a Sphinx extension that embeds source code blocks directly into your documentation as a dropdown.
**Example**
.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-inlinecode/main/docs/source/_static/example.png
:alt: embedded code block added by sphinx-inlinecode
Unlike |.sphinx.ext.viewcode|_, source code blocks will also be added for |.property|_ and |.functools.cached_property+cached_property|_ entries
Installation
~~~~~~~~~~~~
To install ``sphinx-inlinecode`` via pip::
pip install sphinx-inlinecode
Configuration
~~~~~~~~~~~~~~
Add the extension to your ``conf.py``
.. code-block:: python
extensions = [
"sphinx_inlinecode",
]
Documentation
~~~~~~~~~~~~~~~
Full documentation can be found on |RTD|_
.. |RTD| replace:: ReadTheDocs
.. _RTD: https://sphinx-inlinecode.readthedocs.io/en/latest/
Raw data
{
"_id": null,
"home_page": "https://github.com/tdkorn/sphinx-inlinecode",
"name": "sphinx-inlinecode",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "sphinx, viewcode, sphinx-extension, sphinx-contrib, code-block, inline-code, sphinx-ext, inline, embed, documentation",
"author": "Adam Korn",
"author_email": "hello@dailykitten.net",
"download_url": "https://files.pythonhosted.org/packages/27/9d/968cf751ddc6501be07810985ef9bf9d00d1797b5b6575ff8204452c16ad/sphinx-inlinecode-2.0.1.tar.gz",
"platform": null,
"description": ".. |.functools.cached_property+cached_property| replace:: ``cached_property``\n.. _.functools.cached_property+cached_property: https://docs.python.org/3/library/functools.html#functools.cached_property\n.. |.property| replace:: ``property``\n.. _.property: https://docs.python.org/3/library/functions.html#property\n.. |.sphinx.ext.viewcode| replace:: ``sphinx.ext.viewcode``\n.. _.sphinx.ext.viewcode: https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html#module-sphinx.ext.viewcode\n\n\n.. meta::\n :author: Adam Korn\n :title: sphinx-inlinecode - embed source code blocks directly into Sphinx documentation\n :description: A Sphinx extension to embed source code blocks directly into Sphinx documentation\n\n\nsphinx-inlinecode\n--------------------\n\n.. image:: https://img.shields.io/pypi/v/sphinx-inlinecode?color=eb5202\n :target: https://pypi.org/project/sphinx-inlinecode/\n :alt: sphinx-inlinecode PyPI Version\n\n.. image:: https://img.shields.io/badge/GitHub-sphinx--inlinecode-4f1abc\n :target: https://github.com/tdkorn/sphinx-inlinecode/\n :alt: sphinx-inlinecode GitHub Repository\n\n.. image:: https://static.pepy.tech/personalized-badge/sphinx-inlinecode?period=total&units=none&left_color=grey&right_color=blue&left_text=Downloads\n :target: https://pepy.tech/project/sphinx-inlinecode/\n\n.. image:: https://readthedocs.org/projects/sphinx-inlinecode/badge/?version=latest\n :target: https://sphinx-inlinecode.readthedocs.io/en/latest/?badge=latest\n :alt: sphinx-inlinecode Documentation Status\n\n|\n\n``sphinx-inlinecode`` is a Sphinx extension that embeds source code blocks directly into your documentation as a dropdown.\n\n\n**Example**\n\n\n.. image:: https://raw.githubusercontent.com/TDKorn/sphinx-inlinecode/main/docs/source/_static/example.png\n :alt: embedded code block added by sphinx-inlinecode\n\n\n\n\n\nUnlike |.sphinx.ext.viewcode|_, source code blocks will also be added for |.property|_ and |.functools.cached_property+cached_property|_ entries\n\n\nInstallation\n~~~~~~~~~~~~\n\nTo install ``sphinx-inlinecode`` via pip::\n\n pip install sphinx-inlinecode\n\n\nConfiguration\n~~~~~~~~~~~~~~\n\nAdd the extension to your ``conf.py``\n\n.. code-block:: python\n\n extensions = [\n \"sphinx_inlinecode\",\n ]\n\n\n\nDocumentation\n~~~~~~~~~~~~~~~\n\nFull documentation can be found on |RTD|_\n\n\n.. |RTD| replace:: ReadTheDocs\n.. _RTD: https://sphinx-inlinecode.readthedocs.io/en/latest/\n\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A Sphinx extension to embed source code blocks directly into documentation",
"version": "2.0.1",
"project_urls": {
"Download": "https://github.com/TDKorn/sphinx-inlinecode/tarball/main",
"Homepage": "https://github.com/tdkorn/sphinx-inlinecode"
},
"split_keywords": [
"sphinx",
" viewcode",
" sphinx-extension",
" sphinx-contrib",
" code-block",
" inline-code",
" sphinx-ext",
" inline",
" embed",
" documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14b7bc445111dc4b2d5204b9937215d7f14b78a156195dce25128d8bc11ffda5",
"md5": "3e8414c636a312106cb352b6202d5980",
"sha256": "8ba1b5c8919a4527ee2b7fa01902b80cd0a79376c169787b7c9de74374cb5054"
},
"downloads": -1,
"filename": "sphinx_inlinecode-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3e8414c636a312106cb352b6202d5980",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6665,
"upload_time": "2024-08-18T07:20:10",
"upload_time_iso_8601": "2024-08-18T07:20:10.932338Z",
"url": "https://files.pythonhosted.org/packages/14/b7/bc445111dc4b2d5204b9937215d7f14b78a156195dce25128d8bc11ffda5/sphinx_inlinecode-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "279d968cf751ddc6501be07810985ef9bf9d00d1797b5b6575ff8204452c16ad",
"md5": "0d8bbee39984c592353336dd555a2d5a",
"sha256": "da819bea38c234d391439a5044be32ac30143ad996e5a8169049ae9a6314a1aa"
},
"downloads": -1,
"filename": "sphinx-inlinecode-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "0d8bbee39984c592353336dd555a2d5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6354,
"upload_time": "2024-08-18T07:20:11",
"upload_time_iso_8601": "2024-08-18T07:20:11.856309Z",
"url": "https://files.pythonhosted.org/packages/27/9d/968cf751ddc6501be07810985ef9bf9d00d1797b5b6575ff8204452c16ad/sphinx-inlinecode-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 07:20:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tdkorn",
"github_project": "sphinx-inlinecode",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "sphinx-inlinecode"
}
JSON
