sphinx-contrib / feed /

Filename Size Date modified Message
..
sphinxcontrib
tests
49 B
627 B
81 B
1.1 KB
.. -*- restructuredtext -*-

======================
README for sphinx-feed
======================

This Sphinx extension generates an RSS feed your site containing all articles that occur therein indexed by document "Publish Date". Publish Date is supplied as document metadata. (see test suite for examples)

Licensing
=========
Incorporates feedgenerator.py from the Django project, licensed under the BSD license.
Contributions by Dan MacKinlay are hereby also released under BSD license.

TODO
====
- inject rel="alternate" RSS links into document header pointing to the RSS feed. For now you roll your own in the template
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.