sphinx-code-include is an extension for Sphinx that lets you render source-code of any class or function directly into your Sphinx documentation using only as string.
Example
::
.. code-include :: :func:`os.path.join`
This code-include block renders as: (theme is sphinx_rtd_theme)
.. image :: https://user-images.githubusercontent.com/10103049/67256848-f7422380-f43d-11e9-857a-434ba7bf579f.jpg
As long as the string you've chosen is either
sphinx.ext.viewcode_ enabledthen code-include can find it and render it in your documentation.
::
pip install sphinx-code-include
You can also install the in-development version with::
pip install https://github.com/ColinKennedy/sphinx-code-include/archive/master.zip
https://sphinx-code-include.readthedocs.io/
To run the all tests run::
tox
.. _sphinx.ext.viewcode: https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html
user_agent information. See https://github.com/ColinKennedy/sphinx-code-include/issues/5FAQs
Include source code from any Sphinx project using only its import path
We found that sphinx-code-include demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
AGENTS.md is a fast-growing open format giving AI coding agents a shared, predictable way to understand project setup, style, and workflows.
Security News
/Research
Malicious npm package impersonates Nodemailer and drains wallets by hijacking crypto transactions across multiple blockchains.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.