| Name | sphinx-lfs-content JSON |
| Version |
1.1.8
JSON |
| download |
| home_page | None |
| Summary | Ensure existence of LFS content in your LFS builds |
| upload_time | 2025-01-07 13:25:19 |
| maintainer | None |
| docs_url | None |
| author | Dominic Kempf |
| requires_python | None |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sphinx_lfs_content
[](https://badge.fury.io/py/sphinx-lfs-content)
[](https://sphinx-lfs-content.readthedocs.io/en/latest/?badge=latest)
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](https://github.com/readthedocs/readthedocs.org/issues/1846).
## Installation
The extension can be installed from PyPI using `pip`:
```python
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`:
```python
# 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](https://github.com/git-lfs/git-lfs), 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.
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-lfs-content",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Dominic Kempf",
"author_email": "dominic.kempf@iwr.uni-heidelberg.de",
"download_url": "https://files.pythonhosted.org/packages/dc/e6/cf1cd5304e1429f3f236c2a99e056664b333006a26caacb3c13a2b2f5ba5/sphinx_lfs_content-1.1.8.tar.gz",
"platform": null,
"description": "# sphinx_lfs_content\n\n[](https://badge.fury.io/py/sphinx-lfs-content)\n[](https://sphinx-lfs-content.readthedocs.io/en/latest/?badge=latest)\n\nGit LFS is a popular method to store large files like e.g. documentation assets in git repositories.\nBuilding such documentation on a system without Git LFS will typically result in broken documentation. \n`sphinx_lfs_content` is a minimalistic Sphinx extension that ensures that `git-lfs` is installed and otherwise installs it and fetches LFS content.\nIt is motivated by the [lack of LFS support on readthedocs.org](https://github.com/readthedocs/readthedocs.org/issues/1846).\n\n## Installation\n\nThe extension can be installed from PyPI using `pip`:\n\n```python\npython -m pip install sphinx_lfs_content\n```\n\nIf you use a requirements file to describe the dependencies of your documentation build, simply add `sphinx_lfs_content` to it.\n\n## How to use it\n\nAdd the following lines to your `conf.py`:\n\n```python\n# The list of enabled extensions\nextensions = [\n \"sphinx_lfs_content\",\n]\n```\n\nThat's all. The extension will check whether the system has `git-lfs` and download a version\nfrom the [`git-lfs` GitHub page](https://github.com/git-lfs/git-lfs), verify its checksum\nand checkout any LFS content.\n\nAdditionally, a configuration value `lfs_content_post_commands` is available. It accepts a list\nof strings with commands that will be executed after the git-lfs checkout was performed.\nThis can be used to resolve chicken-egg situations with other setup code.\n\n## Restrictions\n\nThe extension is very likely to only work on Linux right now, as it does not properly select the `git-lfs` archive to download.",
"bugtrack_url": null,
"license": null,
"summary": "Ensure existence of LFS content in your LFS builds",
"version": "1.1.8",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dce6cf1cd5304e1429f3f236c2a99e056664b333006a26caacb3c13a2b2f5ba5",
"md5": "100440c3dc56c9d77dcfe35fe35660cf",
"sha256": "68a50835af2ee2eb5d170036344b932686e4439094fd0d09c68846edbe2fcfec"
},
"downloads": -1,
"filename": "sphinx_lfs_content-1.1.8.tar.gz",
"has_sig": false,
"md5_digest": "100440c3dc56c9d77dcfe35fe35660cf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3181,
"upload_time": "2025-01-07T13:25:19",
"upload_time_iso_8601": "2025-01-07T13:25:19.179413Z",
"url": "https://files.pythonhosted.org/packages/dc/e6/cf1cd5304e1429f3f236c2a99e056664b333006a26caacb3c13a2b2f5ba5/sphinx_lfs_content-1.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-07 13:25:19",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-lfs-content"
}
