TDKorn / sphinx-inlinecode

A Sphinx extension to embed source code blocks directly into documentation

Home Page:https://sphinx-inlinecode.readthedocs.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

sphinx-inlinecode

sphinx-inlinecode PyPI Version

sphinx-inlinecode GitHub Repository

image

sphinx-inlinecode Documentation Status

sphinx-inlinecode is a Sphinx extension that embeds source code blocks directly into your documentation as a dropdown.

Example

embedded code block added by sphinx-inlinecode

Unlike sphinx.ext.viewcode_, source code blocks will also be added for property_ and cached_property_ entries

Installation

To install sphinx-inlinecode via pip:

pip install sphinx-inlinecode

Configuration

Add the extension to your conf.py

extensions = [
    "sphinx_inlinecode",
]

Documentation

Full documentation can be found on ReadTheDocs_

About

A Sphinx extension to embed source code blocks directly into documentation

https://sphinx-inlinecode.readthedocs.io

License:MIT License


Languages

Language:Python 84.1%Language:CSS 10.3%Language:JavaScript 5.5%