要生成的Sphinx扩展打开图形元数据对于文档的每一页。

python-m pip安装sphinxext-opengraph

只需添加狮身人面像.opengraph到您的扩展列表中conf.py公司

扩展 =[“sphinxext.opengraph”,]

这些值放置在conf.py公司你的狮身人面像项目。

在Read The Docs上托管文档的用户不要除非需要自定义配置，否则需要设置以下任何一项。扩展将自动检索您的站点URL。

• ogp_site_url
  • 此配置选项非常重要，请将其设置为网站所在的URL。
• ogp_description_长度
  • 配置从页面中提取的字符数。默认值200可能对大多数人都有好处。如果使用了数字以外的其他值，则默认返回到200。
• 日志_站点名称
  • 这不是必需的。站点的名称。这显示在标题上方。默认为狮身人面像项目配置值。设置为False（错误）取消设置并使用无默认值。
• ogp社交卡
  • 为每个页面自动创建社交媒体卡PNG的配置。有关更多信息，请参阅社交媒体卡文档.
• ogp_图像
  • 这不是必需的。链接到要显示的图像。注意，所有相对路径都被转换为相对于html输出根的路径，定义如下ogp_site_url.
• ogp_image_alt
  • 这不是必需的。图像的Alt文本。默认为使用日志_站点名称或文档标题为alt文本（如果可用）。设置为False（错误）如果你想完全关闭alt文本。
• 日志_使用_第一个图像
  • 这不是必需的。设置为真的使用每个页面的第一个图像（如果可用）。如果设置为真的但没有找到图像，斯芬克斯将使用ogp图像而不是。
• ogp类型
  • 这将设置ogp类型属性，有关可用类型的更多信息，请查看https://ogp.me/#类型。默认设置为网站，这对于大多数用例来说都应该很好。
• 日志_自定义元数据
  • 这不是必需的。要插入的自定义html代码段列表。
• 日志启用元数据描述
  • 这不是必需的。什么时候？真的，生成<meta name=“description”content=“…”>从页面。

ogp_site_url = "http://example.org/"
ogp_图像 = "http://example.org/image.png"

ogp_site_url = "http://example.org/"
ogp_图像 = "http://example.org/image.png"
ogp_description_长度 = 300
ogp类型 = “文章”

日志_自定义元数据 =['<meta property=“og:ignore_canonical”content=“true”/>',]日志启用元数据描述 = 真的

字段列表用于覆盖每个页面上的某些设置，并设置不支持的任意Open Graph标记。

请确保将字段放在文档的最开头，这样Sphinx就会提取它们，并且不会将它们构建到html中。

这些是一些可以在单个页面上使用的覆盖，您实际上可以覆盖任何标记，字段列表将始终优先。

• ：ogp_description_length:
  • 为页面的描述配置要抓取的字符数。如果该值不是数字，它将回落到ogp_description_长度.¹
• ：ogp_disable：
  • 禁用在页面上生成Open Graph标记。¹
• ：og:描述：
  • 用于覆盖页面的描述。
• ：描述：或..元：：\n：描述：
  • 设置<meta name=“description”content=“…”>描述。
• ：og:title（标题）：
  • 允许您覆盖页面的标题。
• ：og:类型：
  • 覆盖页面的类型，查看可用类型列表https://ogp.me/类型.
• ：og:image（图像）：
  • 设置页面的图像。²
• ：og:image:alt:
  • 设置alt文本。如果没有图像集，将被忽略。

记住，田地必须放在文件的最开头。如果这些字段没有显示在最终的html文件中，您可以验证Sphinx是否选中了它们。

：og:description:新描述：og:图像：http://example.org/image.png：og:形象：alt:示例图像页面内容=============

此外，您可以使用字段列表添加扩展不支持的任意Open Graph标记。任意标记的语法与：og:tag:content例如：

：日志：视频：http://example.org/video.mp4页面内容=============