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.
Free software: BSD 2-Clause License
Example
.. code-include :: :func:`os.path.join`
This code-include block renders as: (theme is sphinx_rtd_theme)
As long as the string you’ve chosen is either
is importable
is coming from a project that has sphinx.ext.viewcode enabled
then code-include can find it and render it in your documentation.
Installation
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
Documentation
Development
To run the all tests run:
tox
Changelog
2.0.1 (2025-01-08)
Dropped Python 2.7-3.8 support
Added better CI + mypy
1.4.0 (2024-03-16)
Added better CI, updated GitHub badges, various quality of life changes
1.3.0 (2024-03-14)
Added explicit, separate GitHub workflow actions
1.2.0 (2024-03-13)
Added Python 3.10 support
Added initial GitHub workflow actions
1.1.2 (2023-04-22)
Added missing user_agent information. See https://github.com/ColinKennedy/sphinx-code-include/issues/5
1.1.1 (2019-10-26)
Fixed the requirements of the PyPI package
1.1.0 (2019-10-26)
Added :link-to-source: and :link-to-documentation: options
Added support for the :obj: tag (which can be used in place of :class:, :func:, or :meth:)
1.0.0 (2019-10-20)
First release on PyPI.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-code-include 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_code_include-2.0.0.tar.gz | 235.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_code_include-2.0.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 250.6 kB
Release files / sphinx_code_include-2.0.0.tar.gz
| Download URL | sphinx_code_include-2.0.0.tar.gz |
|---|---|
| Size | 235.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4237f0d99be746beee3c555343907f03dae737bcc7f07671968ee291c2d7b6ce
|
|
BLAKE2b-256 checksum How to use checksums |
a6dcf2303aa342411a6484bccdf7d194d9f4c0da105d79cdc1e0fe653bc01af4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 9, 2025.
Transparency logRelease files / sphinx_code_include-2.0.0-py2.py3-none-any.whl
| Download URL | sphinx_code_include-2.0.0-py2.py3-none-any.whl |
|---|---|
| Size | 15.3 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
4fce2765c8e6fa84b1f7a460412162e50a6b74e44ed7768873293fafc0c2a68c
|
|
BLAKE2b-256 checksum How to use checksums |
9fe3140996a604ba498dad2d7c34ed3772168884f8664eb349003da424baef48
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jan 9, 2025.
Transparency log
