狮身人面像“嵌入”延伸

sphinxcontrib-embedl的Python项目详细描述


这是使用Embedly的狮身人面像扩展。

此扩展允许您嵌入Embedly支持的任何内容, 例如:

.. embedly:: http://www.youtube.com/watch?v=M_eYSuPKP3Y

安装

pip install sphinxcontrib-embedly

配置

狮身人面像

要在sphinx中启用此扩展,请将sphinxcontrib.embedlymodule添加到 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项目,如鹈鹕,请随意添加 下面是您的代码:

from sphinxcontrib.embedly import setup_docutils
setup_docutils()

嵌入键

然后在 conf.py注册了 Embed产品。例如:

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

嵌入式超时

还有一个可选的配置变量embedly_timeout 指定从中获取嵌入代码时使用的默认超时。 嵌入式(默认为60秒)。例如:

embedly_timeout = 120

用法

此指令获取给定url的嵌入代码并将其添加到 生成的文档。

示例:

.. embedly:: http://www.youtube.com/watch?v=M_eYSuPKP3Y

您可以为嵌入指定各种选项,如上所示。

示例:

.. embedly:: http://www.youtube.com/watch?v=M_eYSuPKP3Y
   :width: 450
   :autoplay:
   :frame:

选项

maxwidth:the maximum width of the embed in pixels (optional)
maxheight:the maximum height of the embed in pixels (optional)
width:the scaled width of rich and video embeds in pixels (optional)
wmode:the “wmode” parameter to flash objects, options are “window”, “opaque” and “transparent” (optional)
nostyle:boolean when given removes inline style elements from certain embeds to be able to style them yourself (optional)
autoplay:boolean when given tells the video and rich embeds to automatically play when the media is loaded (optional)
videosrc:boolean when given uses the ^{tt7}$ meta or Open Graph tag to create a video object to embed (optional, defaults to 50)
words:integer value of words to be returned as the description, as the closest sentence to that word count (optional)
chars:integer value of characters after which the description is blindly truncated and added “…” (optional)
frame:boolean when given will wrap all embeds in iframes to help prevent XSS attacks (optional, available in the paid products)
secure:boolean when given will serve embeds with a SSL connection (optional, available in the paid products)

更改日志

V0.2(2014-02-23)

v0.1(2013-12-30)

  • 初次发布。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
JavaHibernate:如何使用第三个表将属性与条件连接起来   java JMS/REST客户端是作为一个集中的库,还是每个微服务一个?   java在Netbeans中生成重复代码   java处理无法映射到SOA中一个frontendpage的错误   java EditText getText不在按钮中工作单击   java您能阻止WatchService在Windows上锁定文件吗?   java在Hadoop中使用wget?   无活动数据库连接的java部署JEE/JPA应用程序   平台模块应用程序中netbeans缺少java库(netbeans 7.3.1)   java在屏幕上分布一个数据网格,它的所有项目都是可见的   在java中获得约会   if语句是Java中计算最小数的标准方法   在openGL中找不到用于纹理创建的java文件路径   java如何在firebase中运行查询以检索具有当前日期的对象?   java如何更快地加载(库)滑动图像?安卓   java将变量传递给另一个类是否使用同一个类?   在Java中,biginteger尾部递归函数仍在破坏堆栈   java蓝图服务列表:等待所有服务