确保在您的LFS构建中存在LFS内容
项目描述
sphinx_lfs_content
Git LFS是一种流行的在git仓库中存储大型文件(如文档资产)的方法。在没有Git LFS的系统上构建此类文档通常会导致文档损坏。sphinx_lfs_content
是一个简约的Sphinx扩展,它确保安装了git-lfs
并安装它以获取LFS内容。它是由readthedocs.org缺乏LFS支持而激发的。
安装
可以使用pip
从PyPI安装此扩展
python -m pip install sphinx_lfs_content
如果您使用需求文件来描述文档构建的依赖关系,只需将sphinx_lfs_content
添加到其中即可。
如何使用它
将以下行添加到您的conf.py
# The list of enabled extensions
extensions = [
"sphinx_lfs_content",
]
就这么多了。扩展将检查系统是否已安装git-lfs
,并从git-lfs
GitHub页面下载版本,验证其校验和并检出任何LFS内容。
此外,还提供了一个配置值 lfs_content_post_commands
。它接受一个字符串列表,包含在执行 git-lfs 检出后要执行的命令。这可以用来解决与其他设置代码相关的鸡生蛋问题。
限制
该扩展很可能目前只能在 Linux 上运行,因为它没有正确选择要下载的 git-lfs
归档。
项目详情
关闭
sphinx_lfs_content-1.1.7.tar.gz 的散列
算法 | 散列摘要 | |
---|---|---|
SHA256 | 2336f2c12f4d26fa97d36b64b4b78405ccb0a767a63761f5c169b6e3dedcd46f |
|
MD5 | 1b294b8a633aa0ce82168e3eaf1c101f |
|
BLAKE2b-256 | 307db17bcdf413c77b06bcb328779d9748cab4c1d6f08b75b68b6af830da596d |