Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 690 Bytes

README.rst

File metadata and controls

25 lines (16 loc) · 690 Bytes

sphinxfeed

This Sphinx extension is derived from Dan Mackinlay's sphinxcontrib.feed package.

It relies on the feedformatter package instead of Django utils to generate the feed.

Usage

  1. Install sphinxfeed using easy_install / pip / python setup.py install

  2. Add sphinxfeed to the list of extensions in your conf.py:

    extensions = [..., 'sphinxfeed']
    
  3. Customise the necessary configuration options to correctly generate the feed:

    feed_base_url = 'http://YOUR_HOST_URL'
    feed_author = 'YOUR NAME'