.. |.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": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"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/7a/05/7fbf1cfa72639bd677d82bf3cfa3e6ae7e046ef0dc126af993295d31ba1d/sphinx-inlinecode-2.0.0.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.0",
"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": "778a17655fa4b6433ee499821172752e004b4619896faa38ac7de934ac73ae9f",
"md5": "98b259180fef2c4b45b64705949d1c8c",
"sha256": "22c70e359d78977803fb6d9879406b7475bbdde5fb841144f9eb8148c6557ffb"
},
"downloads": -1,
"filename": "sphinx_inlinecode-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "98b259180fef2c4b45b64705949d1c8c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6657,
"upload_time": "2024-02-07T05:34:12",
"upload_time_iso_8601": "2024-02-07T05:34:12.059630Z",
"url": "https://files.pythonhosted.org/packages/77/8a/17655fa4b6433ee499821172752e004b4619896faa38ac7de934ac73ae9f/sphinx_inlinecode-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a057fbf1cfa72639bd677d82bf3cfa3e6ae7e046ef0dc126af993295d31ba1d",
"md5": "3e2066c90142a9213b08be5acdf55bc8",
"sha256": "e2e8d4df637b3d01102798f330bb553af65b8886e186406c27bf7c0123d12454"
},
"downloads": -1,
"filename": "sphinx-inlinecode-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3e2066c90142a9213b08be5acdf55bc8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6381,
"upload_time": "2024-02-07T05:34:13",
"upload_time_iso_8601": "2024-02-07T05:34:13.829991Z",
"url": "https://files.pythonhosted.org/packages/7a/05/7fbf1cfa72639bd677d82bf3cfa3e6ae7e046ef0dc126af993295d31ba1d/sphinx-inlinecode-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-07 05:34:13",
"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
