This extension was written by a Sphinx development agent.
sphinx-github-include
sphinx-github-include adds a Sphinx directive for including content directly from GitHub
repositories using the format owner/repo:path.
Basic usage
Include and parse RST or Markdown content:
.. github-include:: sphinx-doc/sphinx:README.rst
:branch: master
:start-line: 21
:end-line: 25
Display code with syntax highlighting using :code::
.. github-include:: python/cpython:Lib/this.py
:code: python
:number-lines:
Display literal text using :literal::
.. github-include:: github/gitignore:Python.gitignore
:literal:
Specify a version with :branch:, :tag:, or :commit: (defaults to main):
.. github-include:: owner/repo:path/to/file.py
:tag: v1.0.0
Filter lines with :start-line:, :end-line:, :start-after:, or :end-before::
.. github-include:: owner/repo:example.py
:start-line: 10
:end-line: 50
Project setup
Install via pip:
pip install sphinx-github-include
Add to your conf.py:
extensions = [
"sphinx_github_include"
]
Community and support
Report issues on the GitHub repository.
sphinx-github-include is covered by the Ubuntu Code of Conduct.
License and copyright
sphinx-github-include is released under the GPL-3.0 license.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-github-include 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_github_include-0.0.1.tar.gz | 127.9 kB | With provenance | Details for sphinx_github_include-0.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_github_include-0.0.1-py3-none-any.whl | Python 3 | none | any | Details for sphinx_github_include-0.0.1-py3-none-any.whl |
Total release size: 146.0 kB
Release files / sphinx_github_include-0.0.1.tar.gz
| Download URL | sphinx_github_include-0.0.1.tar.gz |
|---|---|
| Size | 127.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e79bcd62dc246628340a34bc2b61c75412ec673b5c4f59e176f426d76aa7c7f8
|
|
BLAKE2b-256 checksum How to use checksums |
16c21a430b7951687f278b9626837553bf7cda4e0a3d13e2037af86a0a5f93a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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 Aug 25, 2026.
Transparency logRelease files / sphinx_github_include-0.0.1-py3-none-any.whl
| Download URL | sphinx_github_include-0.0.1-py3-none-any.whl |
|---|---|
| Size | 18.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
203dd3a24f2419da0648d6129c1bebf390b53eadd366f09ffe0381d1ef7b6811
|
|
BLAKE2b-256 checksum How to use checksums |
0e9e9545ff3e35b75681b6a31d03574b6b1f62f3efbd5d050147f61948a64ddc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
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 Aug 25, 2026.
Transparency logSecurity for sphinx-github-include 0.0.1
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.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for sphinx_github_include-0.0.1.tar.gz
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 Aug 25, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
