sphinx-contrib / feed /

Filename Size Date modified Message
49 B
1.1 KB
255 B
81 B
1.3 KB
.. -*- restructuredtext -*-

README for sphinx-feed

This Sphinx extension generates an RSS feed your site containing all articles
that occur therein, indexed by document date. Date is supplied as a standard
document metadata field. (The `ReST cheat sheet`_ has one, for example, or see
the test suite for other examples.)


Incorporates feedgenerator.py from the Django project, licensed under the BSD

The rest of the project is also released under the BSD licence.


Original version by `Dan MacKinlay`_ with contributions by `Keegan
Carruthers-Smith`_. Contributors hereby release their code under the BSD


* inject rel="alternate" RSS links into document header pointing to
  the RSS feed. For now you roll your own in the template
* go from the irritating nose tests to the conventional and more debug-
  friendly unittests

.. _ReST cheat sheet: http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt
.. _Dan MacKinlay: http://livingthing.org/
.. _Keegan Carruthers-Smith: http://people.cs.uct.ac.za/~ksmith/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.