sphinxcontrib-embedly 0.2

Sphinx

要在Sphinx中启用此扩展，请将sphinxcontrib.embedly模块添加到conf.py文件中的extensions选项。

import os, sys

# Path to the folder where sphinxcontrib/embedly.py is
# NOTE: not needed if the package is installed in traditional way
# using setup.py, easy_install or pip
sys.path.append(os.path.abspath('/path/to/sphinxcontrib.embedly'))

# Enabled extensions
extensions = ['sphinxcontrib.embedly']

Docutils

如果您使用纯Docutils项目（如Pelican），请随意在您的代码中添加以下内容。

from sphinxcontrib.embedly import setup_docutils
setup_docutils()

embedly_key

然后，通过在Embedly上注册免费账户并在Embed产品中注册，设置embedly_key配置变量。例如：

embedly_key = '<api-key-copied-from-your-account-page>'

embedly_timeout

此外，还有一个可选配置变量embedly_timeout，它指定从Embedly获取嵌入代码时使用的默认超时时间（默认为60秒）。例如：

embedly_timeout = 120

选项

maxwidth:

嵌入的最大宽度（像素）（可选）

maxheight:

嵌入的最大高度（以像素为单位，可选）

宽度:

富内容和视频嵌入的缩放宽度（以像素为单位，可选）

wmode:

用于Flash对象的“wmode”参数，选项有“window”，“opaque”和“transparent”（可选）

nostyle:

当给出时为布尔值，移除某些嵌入的行内样式元素，以便您可以自己进行样式设置（可选）

autoplay:

当给出时为布尔值，指示视频和富嵌入在媒体加载时自动播放（可选）

videosrc:

当给出时为布尔值，使用video_src元数据或Open Graph标签创建视频对象进行嵌入（可选，默认为50）

words:

要作为描述返回的单词值的整数，作为最接近该单词计数的句子（可选）

chars:

描述在添加“…”之前截断的字符值的整数（可选）

frame:

当给出时为布尔值，将所有嵌入包装在iframe中，以帮助防止XSS攻击（可选，仅在付费产品中可用）

secure:

当给出时为布尔值，将使用SSL连接提供嵌入（可选，仅在付费产品中可用）

v0.2 (2014-02-23)

• 处理“rich”类型的嵌入，例如Slideshare。感谢Doug Hellmann。

• 从Bitbucket仓库迁移到Github

  https://github.com/jezdez/sphinxcontrib-embedly

v0.1 (2013-12-30)

• 初始发布。