sphinxcontrib-newsfeed 0.1.4

概述

sphinxcontrib-newsfeed 是一个扩展，可以将简单的 博客、新闻 或 公告 部分添加到 Sphinx 网站。

功能

• 从Sphinx文档创建源条目。

• 生成带有摘要的条目列表。

• 将源保存为RSS格式的文件。

• 支持通过 Disqus 进行评论。

您可以在 http://htsql.org/blog/ 上看到此扩展的实际应用。有关更多示例，请参阅源代码包中的 demo 目录。

本软件由 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文件名并描述了订阅源元数据。

您需要手动更新您的HTML模板以添加RSS订阅链接。

<link rel="alternate"
      type="application/rss+xml"
      title="Elvensense News"
      href="/index.rss" />

参考