画廊和 gallery-grid 指令

在一些地方，我们使用 sphinx-design 来生成包含结构化文本和图像的网格“画廊”。我们创建了一个小型的 Sphinx 指令，使其在文档中更容易重复此过程，并避免过度重复。它位于 docs/scripts/ 文件夹中的专用模块中，并在整个文档中重复使用。

示例画廊

此主题的文档包含使用此主题进行文档的网站画廊。这些图像在 ReadTheDocs 构建期间自动生成，但不会在本地或测试构建中自动生成（以节省时间）。

如果您在生成这些图像之前在本地构建文档，您可能会收到 Sphinx 警告或错误，但这没关系，只要图像在 ReadTheDocs 测试中构建即可。

在本地下载画廊图像

如果您想在本地构建这些图像以在主题中预览，请执行以下步骤

1. 安装 playwright 和 Chromium 浏览器附加组件

   $ pip install playwright
   $ playwright install chromium
   

2. 从存储库根目录执行画廊生成脚本

   $ python ./docs/scripts/generate_gallery_images.py
   

注意

新生成的图像将被推送到远程存储库。