Sphinx extension for generating RSS feeds
Project description
This Sphinx extension is a fork of Fergus Doyle’s sphinxfeed package which itself is derived from Dan Mackinlay’s sphinxcontrib.feed package. It relies on Lars Kiesow’s python-feedgen package instead of the defunct feedformatter package or of Django utils to generate the feed.
Installation
Soon you can install it using pip:
pip install sphinxfeed-lsaffre
How to test whether the right version of sphinxfeed is installed:
>>> import sphinxfeed >>> sphinxfeed.__version__ '0.3.1'
Usage
Add sphinxfeed to the list of extensions in your conf.py:
extensions = [..., 'sphinxfeed']
Customise the necessary configuration options to correctly generate the feed:
feed_base_url = 'https://YOUR_HOST_URL' feed_author = 'YOUR NAME' feed_description = "A longer description" # optional options feed_field_name = 'date' # default value is "Publish Date" feed_use_atom = False use_dirhtml = False
Optionally use the following metadata fields:
date (or any other name configured using feed_field_name)
author
tags
category
Sphinxfeed will include only .rst files that have a :date: field with a date that does not lie in the future.
Maintenance
See also the files LICENSE and CHANGELOG.rst.
Install a developer version:
git clone https://github.com/lsaffre/sphinxfeed.git pip install -e sphinxfeed
Run the test suite:
$ pytest
Release a new version to PyPI:
$ python -m build $ twine check --strict dist/* $ twine upload dist/*
The twine upload step requires authentication credentials in your ~/.pypirc file.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxfeed_lsaffre-0.3.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22e6da8a87c44a65819a16499da85a795fd3e659f0e628497f9a691f9e15c4da |
|
MD5 | ff989098d833fe75adfba36d18818dc7 |
|
BLAKE2b-256 | b844a696f326dfeb3c1d3ec9c49bad21666c1a55c64af87192028a272b1943e5 |