{"id":19943749,"url":"https://github.com/tdkorn/sphinx-inlinecode","last_synced_at":"2025-05-03T15:33:11.216Z","repository":{"id":203013211,"uuid":"708313123","full_name":"TDKorn/sphinx-inlinecode","owner":"TDKorn","description":"A Sphinx extension to embed source code blocks directly into documentation","archived":false,"fork":false,"pushed_at":"2024-08-18T07:19:42.000Z","size":3345,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-07T17:52:43.260Z","etag":null,"topics":["source-code","sphinx","sphinx-contrib","sphinx-doc","sphinx-extension","viewcode"],"latest_commit_sha":null,"homepage":"https://sphinx-inlinecode.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TDKorn.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-22T07:11:19.000Z","updated_at":"2024-08-18T07:19:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"c85a9cc1-e671-4f2c-ae18-4af30d9b14ed","html_url":"https://github.com/TDKorn/sphinx-inlinecode","commit_stats":null,"previous_names":["tdkorn/sphinx-inlinecode"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TDKorn%2Fsphinx-inlinecode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TDKorn%2Fsphinx-inlinecode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TDKorn%2Fsphinx-inlinecode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TDKorn%2Fsphinx-inlinecode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TDKorn","download_url":"https://codeload.github.com/TDKorn/sphinx-inlinecode/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252211852,"owners_count":21712477,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["source-code","sphinx","sphinx-contrib","sphinx-doc","sphinx-extension","viewcode"],"created_at":"2024-11-13T00:17:52.846Z","updated_at":"2025-05-03T15:33:10.690Z","avatar_url":"https://github.com/TDKorn.png","language":"Python","readme":".. |.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\u0026units=none\u0026left_color=grey\u0026right_color=blue\u0026left_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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftdkorn%2Fsphinx-inlinecode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftdkorn%2Fsphinx-inlinecode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftdkorn%2Fsphinx-inlinecode/lists"}