{"id":19252380,"url":"https://github.com/ssciwr/sphinx_lfs_content","last_synced_at":"2025-07-27T02:37:46.434Z","repository":{"id":38298455,"uuid":"383143255","full_name":"ssciwr/sphinx_lfs_content","owner":"ssciwr","description":"Ensure existence of LFS data in Sphinx builds e.g. on ReadTheDocs","archived":false,"fork":false,"pushed_at":"2025-02-03T13:19:19.000Z","size":74,"stargazers_count":10,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-21T13:38:41.970Z","etag":null,"topics":["git-lfs","hacktoberfest","iwr-hacktoberfest","sphinx","sphinx-extension"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ssciwr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-05T13:03:12.000Z","updated_at":"2025-02-03T13:19:16.000Z","dependencies_parsed_at":"2024-01-22T11:30:29.278Z","dependency_job_id":"4d1da278-19b0-4407-a0b7-bba1790bf6f9","html_url":"https://github.com/ssciwr/sphinx_lfs_content","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssciwr%2Fsphinx_lfs_content","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssciwr%2Fsphinx_lfs_content/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssciwr%2Fsphinx_lfs_content/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssciwr%2Fsphinx_lfs_content/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ssciwr","download_url":"https://codeload.github.com/ssciwr/sphinx_lfs_content/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ssciwr%2Fsphinx_lfs_content/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":258203064,"owners_count":22664491,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["git-lfs","hacktoberfest","iwr-hacktoberfest","sphinx","sphinx-extension"],"created_at":"2024-11-09T18:26:39.997Z","updated_at":"2025-06-15T05:33:49.869Z","avatar_url":"https://github.com/ssciwr.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sphinx_lfs_content\n\n[![PyPI version](https://badge.fury.io/py/sphinx-lfs-content.svg)](https://badge.fury.io/py/sphinx-lfs-content)\n[![Documentation Status](https://readthedocs.org/projects/sphinx-lfs-content/badge/?version=latest)](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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssciwr%2Fsphinx_lfs_content","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fssciwr%2Fsphinx_lfs_content","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fssciwr%2Fsphinx_lfs_content/lists"}