Skip to content

Commit

Permalink
Add instructions to add images to gallery (#1205)
Browse files Browse the repository at this point in the history
Co-authored-by: Mao Zhou <[email protected]>
  • Loading branch information
seisman and ZMAlt authored Sep 16, 2023
1 parent a0b0e81 commit dbeee14
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,27 @@
简要描述绘图意义、所用核心模块的关键语法以及绘图必需的数据等。
新增实例时,请参考\ `文档风格`_\ 和已有的\ :doc:`社区绘图实例 </gallery/index>`。

添加图片到图库
--------------

为了将某个图片添加到\ :doc:`图库 </gallery/index>`\ 中,需要修改
:file:`source/gallery/gallery.yaml` 文件。
每个示例对应一个记录,每个记录的格式如下::

- image: 7b2bde15fb251533e033c4653ebfd207
title: 绘制 GPS 速度场
target: examples/ex015/

其中:

- ``image`` 为图片名,其可以有两种形式:

- 完整的 URL
- 一个由字母和数字组成的字符串,为生成该图片的脚本的 MD5 值,可通过在网页文档中点击对应图片,然后从 URL 中提取

- ``title`` 是显示在图片下方的标题
- ``target`` 是点击图片时要跳转的链接,可以是某个页面的路径,也可以是某个页面的锚点名称

构建文档
--------

Expand Down

0 comments on commit dbeee14

Please sign in to comment.