图库和 gallery-grid
指令#
有几个地方使用 sphinx-design
来生成带有结构化文本和图像的网格“图库”。创建了一个小的 Sphinx 指令,以便在文档中更容易重复此过程,并避免过多重复。它位于 docs/scripts/
文件夹中的专用模块中,并在我们的文档中重复使用。
示例图库#
此主题的文档包含使用此主题的站点图库。这些图像在 ReadTheDocs 构建期间自动生成,但在本地或测试构建中不会自动生成(以节省时间)。
如果您在本地构建文档时没有首先生成这些图像,可能会收到 Sphinx 警告或错误,但只要图像在 ReadTheDocs 测试中构建成功,这应该没问题。
在本地下载图库图像#
如果您想在本地构建这些图像以在主题中预览,请按照以下步骤操作:
安装 playwright 和 Chromium 浏览器插件:
$ pip install playwright $ playwright install chromium
从仓库根目录执行图库生成脚本:
$ python ./docs/scripts/generate_gallery_images.py
备注
新生成的图像将被推送到远程仓库。