Sphinx 的新闻提要扩展
项目描述
概述
sphinxcontrib-newsfeed是一个扩展，用于将简单的博客、 新闻或公告 部分添加到Sphinx网站。
特征：
从 Sphinx 文档制作提要条目。
生成带有预告片的条目列表。
将提要保存到 RSS 格式的文件中。
支持通过Disqus发表评论。
你可以在http://htsql.org/blog/看到这个扩展。有关更多示例，请参阅源代码分发中的演示目录。
该软件由 Kirill Simonov ( Prometheus Research, LLC ) 编写，并在 BSD 许可下发布。
用法
要启用此扩展，请将以下行添加到conf.py：
extensions.append('sphinxcontrib.newsfeed')
要向新闻条目添加评论表单，您还需要指定 Disqus网站标识符：
disqus_shortname = '...'
现在，您可以使用指令feed-entry将任何 Sphinx 文档转换为新闻条目。例如：
Welcome!!! ========== .. feed-entry:: :date: 2012-01-01 Welcome to the news feed of **Elvensense**. Here we will post release announcements and other project news.
使用cut指令将入口预告片与内容分开：
Elvensense 96 is released ========================= .. feed-entry:: :date: 2012-12-31 We are proud to announce a new release of **Elvensense**. .. cut:: Specific changes since the last release: * An exciting feature was added. * An annoying bug was fixed.
要制作新闻条目列表并生成 RSS 文件，请使用feed 指令：
.. feed:: :rss: index.rss :title: Elvensense News release welcome
feed指令的主体必须列出包含新闻条目的文档（类似于toctree）。feed指令的选项定义了 RSS 文件的名称并描述了 feed 元数据。
您需要手动更新 HTML 模板以添加指向 RSS 提要的链接：
<link rel="alternate"
type="application/rss+xml"
title="Elvensense News"
href="/index.rss" />
参考
指令
- 饲料入口
指定条目元数据。
该指令没有正文。
选项：
- 作者
帖子的作者（可选）。
- 日期
以YYYY-MM-DD格式发布的日期。
- 喂养
在当前位置插入带有预告片的条目列表。
该指令应包含文档名称列表（类似于 toctree）。该指令将文档添加到层次结构中，因此您无需添加toctree。
选项：
- RSS
在哪里编写 RSS 提要（可选）。
- 标题
RSS 频道的名称。
- 描述
RSS 频道的说明。
- 关联
网站网址。
- 切
将条目预告片与文本的其余部分分开。
该指令没有选项也没有正文。
- disqus
插入Disqus评论小部件。
通常，您不需要将此指令用于新闻条目，因为如果设置了 disqus_shortname参数，则每个提要条目都会自动包含 Disqus 评论表单。该指令允许您将 Disqus 与常规 Sphinx 文档一起使用。
选项：
- 简称
网站标识符。用于覆盖disqus_shortname 配置参数。
- 标识符
页面标识符。如果未设置，则使用文档名称。
- 标题
页面的标题。如果未设置，则使用文档标题。
配置参数
- disqus_shortname
设置 Disqus 网站的唯一标识符。要获得一个，您需要在http://disqus.com/上注册网站。
- disqus_developer
设置开发者模式（False或True）。
CSS 类
- 饲料元
为发布元数据块包装。
- 提要作者
包装作者姓名。
- 饲料日期
包装发布日期。
- 饲料盘
包装 Disqus 评论小部件。
- 提要参考
将帖子标题包装在帖子列表中。
- 多吃
包装阅读更多...链接。
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
内置分布
sphinxcontrib -newsfeed-0.1.4.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | f78c865b1a32d249644a9c46f395b547df0dc21ed69b70898d64235b4755efb4 |
|
| MD5 | f02110053bb04239a9b2c16d0ea76fe1 |
|
| 布莱克2-256 | 2b5e8bc839b5c4ef030bf26eede24208a49f25d00033cbd4969b3895264f14db |
sphinxcontrib_newsfeed -0.1.4-py2-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 6556e6cb4b4d060c5795f30bc2630589c720ec3678861473155172901f295a9b |
|
| MD5 | 93b7319f2aa53b1b39f9a94ac3b395b9 |
|
| 布莱克2-256 | 2adc47314ad0fd1d0eb77f005481cffeb872eb0d13b049a6b40f1fec9da1fb33 |