sphinx_lfs_content
Git LFS is a popular method to store large files like e.g. documentation assets in git repositories.
Building such documentation on a system without Git LFS will typically result in broken documentation.
sphinx_lfs_content is a minimalistic Sphinx extension that ensures that git-lfs is installed and otherwise installs it and fetches LFS content.
It is motivated by the lack of LFS support on readthedocs.org.
Installation
The extension can be installed from PyPI using pip:
python -m pip install sphinx_lfs_content
If you use a requirements file to describe the dependencies of your documentation build, simply add sphinx_lfs_content to it.
How to use it
Add the following lines to your conf.py:
# The list of enabled extensions
extensions = [
"sphinx_lfs_content",
]
That's all. The extension will check whether the system has git-lfs and download a version
from the git-lfs GitHub page, verify its checksum
and checkout any LFS content.
Additionally, a configuration value lfs_content_post_commands is available. It accepts a list
of strings with commands that will be executed after the git-lfs checkout was performed.
This can be used to resolve chicken-egg situations with other setup code.
Restrictions
The extension is very likely to only work on Linux right now, as it does not properly select the git-lfs archive to download.
Release files for sphinx-lfs-content 1.1.12
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_lfs_content-1.1.12.tar.gz | 3.8 kB | Details |
Release files / sphinx_lfs_content-1.1.12.tar.gz
| Download URL | sphinx_lfs_content-1.1.12.tar.gz |
|---|---|
| Size | 3.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c5516eda44213b70294da88b0d68a9be583e2a05ce2fe3781eb1df7169ecd3c8
|
|
BLAKE2b-256 checksum How to use checksums |
d6e5c8b18804b5d1d0a12f39bc2789fef8956512655d5f4e28d2a51a8d6150d7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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 Oct 1, 2026.
Transparency log
