Integrating news feeds into Sphinx pages

26 January 2010

I’ve worked on a few Sphinx-based websites for software projects lately. (I’ve found the matplotlib sphinx tutorial useful for getting started.) A couple of examples are the PyCogent and PyNAST sites.

One thing I’ve needed to do was integrate a news feed that is easy for developers on the project to update, without having to mess with uploading new html, sharing the site password, etc. The solution I came up with was creating a wordpress blog (e.g., PyCogent, PyNAST); using feed.informer to generate a javascript feed digest; and integrating that javascript into the sidebar via custom layout.html"https://pycogent.sourceforge.net">two sites I mentioned above.

The steps are as follows:

  1. Create a blog (I chose wordpress, since that’s what I’ve used the most).
  2. Create a free feed.informer account. There are a few different sites out there that will host your javascript-based ‘feed digest’, but I’ve found this one to be the least obnoxious in terms of including an advertisements (see the ‘Powered by Feed Informer’ note on my sites) and fairly customizable.
  3. Run through the steps of adding your feed to a digest at feed.informer — for my PyNAST wordpress blog, the feed url is: https://pynast.wordpress.com/pynast.

    One option you should be sure to use is ‘Show Only Live Items’, which has the effect of refreshing the feed rather than reading it from feed.informer’s cache. This allows you to, for example, delete posts in your blog and have them no longer show up in your feed digest.

  4. Paste the provided javascript into your layout.html"https://pycogent.svn.sourceforge.net/viewvc/pycogent/trunk/doc/templates/layout.html?content-type=text%2Fplain">PyCogent layout.html"https://pynast.svn.sourceforge.net/viewvc/pynast/doc/_templates/layout.html?content-type=text%2Fplain">PyNAST layout.html"postmetadata"> Leave a Comment » | Software | Permalink
    Posted by gregcaporaso